~ubuntu-branches/ubuntu/raring/postfix/raring

« back to all changes in this revision

Viewing changes to html/local.8.html

Tags: upstream-2.2.6
ImportĀ upstreamĀ versionĀ 2.2.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
5
5
<title> Postfix manual - local(8) </title>
6
6
</head> <body> <pre>
7
 
LOCAL(8)                                                 LOCAL(8)
 
7
LOCAL(8)                                                              LOCAL(8)
8
8
 
9
9
<b>NAME</b>
10
10
       local - Postfix local mail delivery
13
13
       <b>local</b> [generic Postfix daemon options]
14
14
 
15
15
<b>DESCRIPTION</b>
16
 
       The  <b>local</b>  daemon  processes  delivery  requests from the
 
16
       The  <a href="local.8.html"><b>local</b>(8)</a>  daemon processes delivery requests from the
17
17
       Postfix queue manager to deliver mail to local recipients.
18
18
       Each  delivery  request  specifies  a queue file, a sender
19
19
       address, a domain or host to deliver to, and one  or  more
20
20
       recipients.   This program expects to be run from the <a href="master.8.html"><b>mas-</b></a>
21
21
       <a href="master.8.html"><b>ter</b>(8)</a> process manager.
22
22
 
23
 
       The <b>local</b> daemon updates queue files and marks  recipients
24
 
       as finished, or it informs the queue manager that delivery
25
 
       should be tried again at a  later  time.  Delivery  status
26
 
       reports  are  sent  to the <a href="bounce.8.html"><b>bounce</b>(8)</a>, <a href="defer.8.html"><b>defer</b>(8)</a> or <a href="trace.8.html"><b>trace</b>(8)</a>
27
 
       daemon as appropriate.
 
23
       The <a href="local.8.html"><b>local</b>(8)</a> daemon updates queue files and marks  recipi-
 
24
       ents  as  finished,  or  it informs the queue manager that
 
25
       delivery should be tried again at a later  time.  Delivery
 
26
       status  reports  are  sent  to  the <a href="bounce.8.html"><b>bounce</b>(8)</a>, <a href="defer.8.html"><b>defer</b>(8)</a> or
 
27
       <a href="trace.8.html"><b>trace</b>(8)</a> daemon as appropriate.
28
28
 
29
29
<b>SYSTEM-WIDE AND USER-LEVEL ALIASING</b>
30
30
       The system administrator can set up one  or  more  system-
38
38
       rated list of  ~/.<b>forward</b>  like  files  through  the  <b><a href="postconf.5.html#forward_path">for</a>-</b>
39
39
       <b><a href="postconf.5.html#forward_path">ward_path</a></b>  configuration  parameter.  Upon  delivery,  the
40
40
       local delivery agent tries each pathname in the list until
41
 
       a file is found.  The <b><a href="postconf.5.html#forward_path">forward_path</a></b> parameter is subject to
42
 
       interpolation of <b>$user</b> (recipient username), <b>$home</b> (recip-
43
 
       ient home directory), <b>$shell</b> (recipient shell), <b>$recipient</b>
44
 
       (complete  recipient   address),   <b>$extension</b>   (recipient
45
 
       address  extension),  <b>$domain</b>  (recipient  domain),  <b>local</b>
46
 
       (entire recipient address localpart) and <b>$<a href="postconf.5.html#recipient_delimiter">recipient_delim</a>-</b>
47
 
       <b><a href="postconf.5.html#recipient_delimiter">iter</a>.</b>  The  forms  <i>${name?value}</i>  and <i>${name:value}</i> expand
48
 
       conditionally to <i>value</i> when <i>$name</i>  is  (is  not)  defined.
49
 
       Characters  that  may have special meaning to the shell or
50
 
       file system are replaced  by  underscores.   The  list  of
51
 
       acceptable characters is specified with the <b><a href="postconf.5.html#forward_expansion_filter">forward_expan</a>-</b>
52
 
       <b><a href="postconf.5.html#forward_expansion_filter">sion_filter</a></b> configuration parameter.
53
 
 
54
 
       An alias or ~/.<b>forward</b> file may list  any  combination  of
55
 
       external   commands,  destination  file  names,  <b>:include:</b>
56
 
       directives, or mail addresses.  See <a href="aliases.5.html"><b>aliases</b>(5)</a> for a  pre-
57
 
       cise  description. Each line in a user's .<b>forward</b> file has
 
41
       a file is found.
 
42
 
 
43
       Delivery via ~/.<b>.forward</b> files is done with the privileges
 
44
       of the recipient.  Thus, ~/.<b>forward</b>  like  files  must  be
 
45
       readable  by  the  recipient,  and  their parent directory
 
46
       needs to have "execute" permission for the recipient.
 
47
 
 
48
       The <b><a href="postconf.5.html#forward_path">forward_path</a></b> parameter is subject to interpolation  of
 
49
       <b>$user</b>  (recipient  username), <b>$home</b> (recipient home direc-
 
50
       tory),  <b>$shell</b>  (recipient  shell),  <b>$recipient</b>  (complete
 
51
       recipient  address),  <b>$extension</b> (recipient address exten-
 
52
       sion), <b>$domain</b> (recipient domain), <b>$local</b> (entire  recipi-
 
53
       ent address localpart) and <b>$<a href="postconf.5.html#recipient_delimiter">recipient_delimiter</a>.</b> The forms
 
54
       <i>${name?value}</i> and <i>${name:value}</i>  expand  conditionally  to
 
55
       <i>value</i> when <i>$name</i> is (is not) defined.  Characters that may
 
56
       have special meaning to  the  shell  or  file  system  are
 
57
       replaced  by  underscores.  The list of acceptable charac-
 
58
       ters is specified with the  <b><a href="postconf.5.html#forward_expansion_filter">forward_expansion_filter</a></b>  con-
 
59
       figuration parameter.
 
60
 
 
61
       An  alias  or  ~/.<b>forward</b> file may list any combination of
 
62
       external  commands,  destination  file  names,   <b>:include:</b>
 
63
       directives,  or mail addresses.  See <a href="aliases.5.html"><b>aliases</b>(5)</a> for a pre-
 
64
       cise description. Each line in a user's .<b>forward</b> file  has
58
65
       the same syntax as the right-hand part of an alias.
59
66
 
60
 
       When an address is  found  in  its  own  alias  expansion,
61
 
       delivery  is  made  to  the  user  instead. When a user is
 
67
       When  an  address  is  found  in  its own alias expansion,
 
68
       delivery is made to the  user  instead.  When  a  user  is
62
69
       listed in the user's own ~/.<b>forward</b> file, delivery is made
63
 
       to  the  user's mailbox instead.  An empty ~/.<b>forward</b> file
 
70
       to the user's mailbox instead.  An empty  ~/.<b>forward</b>  file
64
71
       means do not forward mail.
65
72
 
66
 
       In order to prevent the mail system from using  up  unrea-
67
 
       sonable   amounts  of  memory,  input  records  read  from
68
 
       <b>:include:</b> or from ~/.<b>forward</b>  files  are  broken  up  into
 
73
       In  order  to prevent the mail system from using up unrea-
 
74
       sonable  amounts  of  memory,  input  records  read   from
 
75
       <b>:include:</b>  or  from  ~/.<b>forward</b>  files  are broken up into
69
76
       chunks of length <b><a href="postconf.5.html#line_length_limit">line_length_limit</a></b>.
70
77
 
71
 
       While  expanding aliases, ~/.<b>forward</b> files, and so on, the
 
78
       While expanding aliases, ~/.<b>forward</b> files, and so on,  the
72
79
       program attempts to avoid duplicate deliveries. The <b><a href="postconf.5.html#duplicate_filter_limit">dupli</a>-</b>
73
 
       <b><a href="postconf.5.html#duplicate_filter_limit">cate_filter_limit</a></b>  configuration parameter limits the num-
 
80
       <b><a href="postconf.5.html#duplicate_filter_limit">cate_filter_limit</a></b> configuration parameter limits the  num-
74
81
       ber of remembered recipients.
75
82
 
76
83
<b>MAIL FORWARDING</b>
77
 
       For the sake of reliability, forwarded mail is  re-submit-
78
 
       ted  as  a new message, so that each recipient has a sepa-
 
84
       For  the sake of reliability, forwarded mail is re-submit-
 
85
       ted as a new message, so that each recipient has  a  sepa-
79
86
       rate on-file delivery status record.
80
87
 
81
88
       In order to stop mail forwarding loops early, the software
82
89
       adds an optional <b>Delivered-To:</b> header with the final enve-
83
 
       lope recipient address. If mail arrives  for  a  recipient
 
90
       lope  recipient  address.  If mail arrives for a recipient
84
91
       that is already listed in a <b>Delivered-To:</b> header, the mes-
85
92
       sage is bounced.
86
93
 
87
94
<b>MAILBOX DELIVERY</b>
88
 
       The default per-user mailbox is a file in  the  UNIX  mail
89
 
       spool  directory (<b>/var/mail/</b><i>user</i> or <b>/var/spool/mail/</b><i>user</i>);
90
 
       the location can be specified with  the  <b><a href="postconf.5.html#mail_spool_directory">mail_spool_direc</a>-</b>
91
 
       <b><a href="postconf.5.html#mail_spool_directory">tory</a></b>  configuration  parameter. Specify a name ending in <b>/</b>
 
95
       The  default  per-user  mailbox is a file in the UNIX mail
 
96
       spool directory (<b>/var/mail/</b><i>user</i> or  <b>/var/spool/mail/</b><i>user</i>);
 
97
       the  location  can be specified with the <b><a href="postconf.5.html#mail_spool_directory">mail_spool_direc</a>-</b>
 
98
       <b><a href="postconf.5.html#mail_spool_directory">tory</a></b> configuration parameter. Specify a name ending  in  <b>/</b>
92
99
       for <b>qmail</b>-compatible <b>maildir</b> delivery.
93
100
 
94
 
       Alternatively, the per-user mailbox can be a file  in  the
95
 
       user's  home  directory  with  a  name  specified  via the
96
 
       <b><a href="postconf.5.html#home_mailbox">home_mailbox</a></b> configuration parameter. Specify  a  relative
 
101
       Alternatively,  the  per-user mailbox can be a file in the
 
102
       user's home  directory  with  a  name  specified  via  the
 
103
       <b><a href="postconf.5.html#home_mailbox">home_mailbox</a></b>  configuration  parameter. Specify a relative
97
104
       path name. Specify a name ending in <b>/</b> for <b>qmail</b>-compatible
98
105
       <b>maildir</b> delivery.
99
106
 
100
 
       Mailbox delivery can be delegated to an  external  command
101
 
       specified  with  the <b><a href="postconf.5.html#mailbox_command">mailbox_command</a></b> configuration parame-
102
 
       ter. The command  executes  with  the  privileges  of  the
103
 
       recipient  user  (exception:  in case of delivery as root,
104
 
       the   command   executes   with    the    privileges    of
105
 
       <b><a href="postconf.5.html#default_privs">default_privs</a></b>).
 
107
       Mailbox  delivery  can be delegated to an external command
 
108
       specified with the <b><a href="postconf.5.html#mailbox_command">mailbox_command</a></b>  configuration  parame-
 
109
       ter.  The  command  executes  with  the  privileges of the
 
110
       recipient  user  (exceptions:  secondary  groups  are  not
 
111
       enabled; in case of delivery as root, the command executes
 
112
       with the privileges of <b><a href="postconf.5.html#default_privs">default_privs</a></b>).
106
113
 
107
 
       Mailbox  delivery  can be delegated to alternative message
108
 
       transports specified in the  <b>master.cf</b>  file.   The  <b><a href="postconf.5.html#mailbox_transport">mail</a>-</b>
109
 
       <b><a href="postconf.5.html#mailbox_transport">box_transport</a></b>  configuration parameter specifies a message
110
 
       transport that is to be used  for  all  local  recipients,
111
 
       regardless  of  whether  they are found in the UNIX passwd
112
 
       database.  The <b><a href="postconf.5.html#fallback_transport">fallback_transport</a></b>  parameter  specifies  a
 
114
       Mailbox delivery can be delegated to  alternative  message
 
115
       transports  specified  in  the  <b>master.cf</b> file.  The <b><a href="postconf.5.html#mailbox_transport">mail</a>-</b>
 
116
       <b><a href="postconf.5.html#mailbox_transport">box_transport</a></b> configuration parameter specifies a  message
 
117
       transport  that  is  to  be used for all local recipients,
 
118
       regardless of whether they are found in  the  UNIX  passwd
 
119
       database.   The  <b><a href="postconf.5.html#fallback_transport">fallback_transport</a></b>  parameter specifies a
113
120
       message transport for recipients that are not found in the
114
121
       UNIX passwd database.
115
122
 
116
 
       In the case of UNIX-style mailbox delivery, the <b>local</b> dae-
117
 
       mon prepends a "<b>From</b> <i>sender time</i><b>_</b><i>stamp</i>" envelope header to
118
 
       each message, prepends an <b>X-Original-To:</b> header  with  the
119
 
       recipient   address  as  given  to  Postfix,  prepends  an
120
 
       optional <b>Delivered-To:</b>  header  with  the  final  envelope
 
123
       In  the  case of UNIX-style mailbox delivery, the <a href="local.8.html"><b>local</b>(8)</a>
 
124
       daemon prepends a "<b>From</b> <i>sender time</i><b>_</b><i>stamp</i>" envelope header
 
125
       to  each  message,  prepends an <b>X-Original-To:</b> header with
 
126
       the recipient address as given  to  Postfix,  prepends  an
 
127
       optional  <b>Delivered-To:</b>  header  with  the  final envelope
121
128
       recipient address, prepends a <b>Return-Path:</b> header with the
122
 
       envelope sender address, prepends a &gt; character  to  lines
123
 
       beginning  with  "<b>From</b>  ", and appends an empty line.  The
124
 
       mailbox is locked for exclusive access while  delivery  is
125
 
       in  progress.  In  case of problems, an attempt is made to
 
129
       envelope  sender  address, prepends a &gt; character to lines
 
130
       beginning with "<b>From</b> ", and appends an  empty  line.   The
 
131
       mailbox  is  locked for exclusive access while delivery is
 
132
       in progress. In case of problems, an attempt  is  made  to
126
133
       truncate the mailbox to its original length.
127
134
 
128
135
       In the case of <b>maildir</b> delivery, the local daemon prepends
129
 
       an  optional  <b>Delivered-To:</b> header with the final envelope
130
 
       recipient address, prepends an <b>X-Original-To:</b> header  with
131
 
       the  recipient address as given to Postfix, and prepends a
 
136
       an optional <b>Delivered-To:</b> header with the  final  envelope
 
137
       recipient  address, prepends an <b>X-Original-To:</b> header with
 
138
       the recipient address as given to Postfix, and prepends  a
132
139
       <b>Return-Path:</b> header with the envelope sender address.
133
140
 
134
141
<b>EXTERNAL COMMAND DELIVERY</b>
135
 
       The   <b><a href="postconf.5.html#allow_mail_to_commands">allow_mail_to_commands</a></b>    configuration    parameter
136
 
       restricts  delivery to external commands. The default set-
137
 
       ting (<b>alias,  forward</b>)  forbids  command  destinations  in
 
142
       The    <b><a href="postconf.5.html#allow_mail_to_commands">allow_mail_to_commands</a></b>    configuration   parameter
 
143
       restricts delivery to external commands. The default  set-
 
144
       ting  (<b>alias,  forward</b>)  forbids  command  destinations in
138
145
       <b>:include:</b> files.
139
146
 
140
 
       The  command  is  executed directly where possible. Assis-
141
 
       tance by the shell (<b>/bin/sh</b> on UNIX systems) is used  only
142
 
       when  the command contains shell magic characters, or when
 
147
       Optionally, the process working directory  is  changed  to
 
148
       the path specified with <b><a href="postconf.5.html#command_execution_directory">command_execution_directory</a></b> (Post-
 
149
       fix 2.2 and later). Failure  to  change  directory  causes
 
150
       mail to be deferred.
 
151
 
 
152
       The <b><a href="postconf.5.html#command_execution_directory">command_execution_directory</a></b> parameter value is subject
 
153
       to interpolation  of  <b>$user</b>  (recipient  username),  <b>$home</b>
 
154
       (recipient  home  directory),  <b>$shell</b>  (recipient  shell),
 
155
       <b>$recipient</b>  (complete   recipient   address),   <b>$extension</b>
 
156
       (recipient address extension), <b>$domain</b> (recipient domain),
 
157
       <b>$local</b> (entire recipient address localpart)  and  <b>$recipi-</b>
 
158
       <b>ent_delimiter.</b>   The forms <i>${name?value}</i> and <i>${name:value}</i>
 
159
       expand conditionally to  <i>value</i>  when  <i>$name</i>  is  (is  not)
 
160
       defined.   Characters that may have special meaning to the
 
161
       shell or file system are  replaced  by  underscores.   The
 
162
       list of acceptable characters is specified with the <b><a href="postconf.5.html#execution_directory_expansion_filter">execu</a>-</b>
 
163
       <b><a href="postconf.5.html#execution_directory_expansion_filter">tion_directory_expansion_filter</a></b> configuration parameter.
 
164
 
 
165
       The command is executed directly  where  possible.  Assis-
 
166
       tance  by the shell (<b>/bin/sh</b> on UNIX systems) is used only
 
167
       when the command contains shell magic characters, or  when
143
168
       the command invokes a shell built-in command.
144
169
 
145
 
       A limited amount of command output  (standard  output  and
146
 
       standard  error) is captured for inclusion with non-deliv-
147
 
       ery status reports.  A command is forcibly  terminated  if
148
 
       it  does  not  complete within <b><a href="postconf.5.html#command_time_limit">command_time_limit</a></b> seconds.
149
 
       Command exit status codes are expected to follow the  con-
 
170
       A  limited  amount  of command output (standard output and
 
171
       standard error) is captured for inclusion with  non-deliv-
 
172
       ery  status  reports.  A command is forcibly terminated if
 
173
       it does not complete  within  <b><a href="postconf.5.html#command_time_limit">command_time_limit</a></b>  seconds.
 
174
       Command  exit status codes are expected to follow the con-
150
175
       ventions defined in &lt;<b>sysexits.h</b>&gt;.
151
176
 
152
 
       A  limited amount of message context is exported via envi-
153
 
       ronment variables. Characters that may have special  mean-
 
177
       A limited amount of message context is exported via  envi-
 
178
       ronment  variables. Characters that may have special mean-
154
179
       ing to the shell are replaced by underscores.  The list of
155
180
       acceptable characters is specified with the <b><a href="postconf.5.html#command_expansion_filter">command_expan</a>-</b>
156
181
       <b><a href="postconf.5.html#command_expansion_filter">sion_filter</a></b> configuration parameter.
177
202
 
178
203
       <b>SENDER</b> The entire sender address.
179
204
 
 
205
       Additional remote client information is made available via
 
206
       the following environment variables:
 
207
 
 
208
       <b>CLIENT_ADDRESS</b>
 
209
              Remote client  network  address.  Available  as  of
 
210
              Postfix 2.2.
 
211
 
 
212
       <b>CLIENT_HELO</b>
 
213
              Remote  client EHLO command parameter. Available as
 
214
              of Postfix 2.2.
 
215
 
 
216
       <b>CLIENT_HOSTNAME</b>
 
217
              Remote client hostname.  Available  as  of  Postfix
 
218
              2.2.
 
219
 
 
220
       <b>CLIENT_PROTOCOL</b>
 
221
              Remote  client  protocol.  Available  as of Postfix
 
222
              2.2.
 
223
 
 
224
       <b>SASL_METHOD</b>
 
225
              SASL authentication method specified in the  remote
 
226
              client AUTH command. Available as of Postfix 2.2.
 
227
 
 
228
       <b>SASL_SENDER</b>
 
229
              SASL  sender address specified in the remote client
 
230
              MAIL FROM command. Available as of Postfix 2.2.
 
231
 
 
232
       <b>SASL_USERNAME</b>
 
233
              SASL username specified in the remote  client  AUTH
 
234
              command.  Available as of Postfix 2.2.
 
235
 
180
236
       The <b>PATH</b> environment variable is always reset to a system-
181
 
       dependent  default  path,  and environment variables whose
182
 
       names are blessed by the <b><a href="postconf.5.html#export_environment">export_environment</a></b>  configuration
 
237
       dependent default path, and  environment  variables  whose
 
238
       names  are blessed by the <b><a href="postconf.5.html#export_environment">export_environment</a></b> configuration
183
239
       parameter are exported unchanged.
184
240
 
185
241
       The current working directory is the mail queue directory.
186
242
 
187
 
       The <b>local</b> daemon prepends a "<b>From</b> <i>sender time</i><b>_</b><i>stamp</i>" enve-
188
 
       lope  header  to  each message, prepends an <b>X-Original-To:</b>
189
 
       header with the recipient address  as  given  to  Postfix,
190
 
       prepends  an  optional <b>Delivered-To:</b> header with the final
 
243
       The  <a href="local.8.html"><b>local</b>(8)</a>  daemon  prepends a "<b>From</b> <i>sender time</i><b>_</b><i>stamp</i>"
 
244
       envelope header to each message, prepends  an  <b>X-Original-</b>
 
245
       <b>To:</b> header with the recipient address as given to Postfix,
 
246
       prepends an optional <b>Delivered-To:</b> header with  the  final
191
247
       recipient envelope address, prepends a <b>Return-Path:</b> header
192
 
       with  the  sender  envelope  address, and appends no empty
 
248
       with the sender envelope address,  and  appends  no  empty
193
249
       line.
194
250
 
195
251
<b>EXTERNAL FILE DELIVERY</b>
196
 
       The delivery format depends on  the  destination  filename
197
 
       syntax.   The default is to use UNIX-style mailbox format.
198
 
       Specify a name ending in <b>/</b>  for  <b>qmail</b>-compatible  <b>maildir</b>
 
252
       The  delivery  format  depends on the destination filename
 
253
       syntax.  The default is to use UNIX-style mailbox  format.
 
254
       Specify  a  name  ending in <b>/</b> for <b>qmail</b>-compatible <b>maildir</b>
199
255
       delivery.
200
256
 
201
 
       The  <b><a href="postconf.5.html#allow_mail_to_files">allow_mail_to_files</a></b> configuration parameter restricts
202
 
       delivery to external files. The  default  setting  (<b>alias,</b>
 
257
       The <b><a href="postconf.5.html#allow_mail_to_files">allow_mail_to_files</a></b> configuration parameter  restricts
 
258
       delivery  to  external  files. The default setting (<b>alias,</b>
203
259
       <b>forward</b>) forbids file destinations in <b>:include:</b> files.
204
260
 
205
 
       In the case of UNIX-style mailbox delivery, the <b>local</b> dae-
206
 
       mon prepends a "<b>From</b> <i>sender time</i><b>_</b><i>stamp</i>" envelope header to
207
 
       each  message,  prepends an <b>X-Original-To:</b> header with the
208
 
       recipient  address  as  given  to  Postfix,  prepends   an
209
 
       optional  <b>Delivered-To:</b>  header  with  the final recipient
210
 
       envelope address, prepends a &gt; character to  lines  begin-
211
 
       ning  with  "<b>From</b> ", and appends an empty line.  The enve-
212
 
       lope sender  address  is  available  in  the  <b>Return-Path:</b>
213
 
       header.   When  the  destination  is a regular file, it is
 
261
       In the case of UNIX-style mailbox delivery,  the  <a href="local.8.html"><b>local</b>(8)</a>
 
262
       daemon prepends a "<b>From</b> <i>sender time</i><b>_</b><i>stamp</i>" envelope header
 
263
       to each message, prepends an  <b>X-Original-To:</b>  header  with
 
264
       the  recipient  address  as  given to Postfix, prepends an
 
265
       optional <b>Delivered-To:</b> header  with  the  final  recipient
 
266
       envelope  address,  prepends a &gt; character to lines begin-
 
267
       ning with "<b>From</b> ", and appends an empty line.   The  enve-
 
268
       lope  sender  address  is  available  in  the <b>Return-Path:</b>
 
269
       header.  When the destination is a  regular  file,  it  is
214
270
       locked for exclusive access while delivery is in progress.
215
271
       In case of problems, an attempt is made to truncate a reg-
216
272
       ular file to its original length.
217
273
 
218
274
       In the case of <b>maildir</b> delivery, the local daemon prepends
219
 
       an  optional  <b>Delivered-To:</b> header with the final envelope
220
 
       recipient address, and prepends an  <b>X-Original-To:</b>  header
 
275
       an optional <b>Delivered-To:</b> header with the  final  envelope
 
276
       recipient  address,  and prepends an <b>X-Original-To:</b> header
221
277
       with the recipient address as given to Postfix.  The enve-
222
 
       lope sender  address  is  available  in  the  <b>Return-Path:</b>
 
278
       lope  sender  address  is  available  in  the <b>Return-Path:</b>
223
279
       header.
224
280
 
225
281
<b>ADDRESS EXTENSION</b>
226
 
       The  optional  <b><a href="postconf.5.html#recipient_delimiter">recipient_delimiter</a></b> configuration parameter
227
 
       specifies how to separate address  extensions  from  local
 
282
       The optional <b><a href="postconf.5.html#recipient_delimiter">recipient_delimiter</a></b>  configuration  parameter
 
283
       specifies  how  to  separate address extensions from local
228
284
       recipient names.
229
285
 
230
 
       For  example,  with  "<b><a href="postconf.5.html#recipient_delimiter">recipient_delimiter</a>  =  +</b>", mail for
231
 
       <i>name</i>+<i>foo</i> is delivered to the  alias  <i>name</i>+<i>foo</i>  or  to  the
232
 
       alias  <i>name</i>,  to  the  destinations  listed in ~<i>name</i>/.<b>for-</b>
 
286
       For example, with  "<b><a href="postconf.5.html#recipient_delimiter">recipient_delimiter</a>  =  +</b>",  mail  for
 
287
       <i>name</i>+<i>foo</i>  is  delivered  to  the  alias <i>name</i>+<i>foo</i> or to the
 
288
       alias <i>name</i>, to  the  destinations  listed  in  ~<i>name</i>/.<b>for-</b>
233
289
       <b>ward</b>+<i>foo</i> or in ~<i>name</i>/.<b>forward</b>, to the mailbox owned by the
234
290
       user <i>name</i>, or it is sent back as undeliverable.
235
291
 
236
 
       In all cases the <b>local</b> daemon prepends an optional `<b>Deliv-</b>
237
 
       <b>ered-To:</b> header line with the final recipient address.
 
292
       In all cases the  <a href="local.8.html"><b>local</b>(8)</a>  daemon  prepends  an  optional
 
293
       `<b>Delivered-To:</b>   header  line  with  the  final  recipient
 
294
       address.
238
295
 
239
296
<b>DELIVERY RIGHTS</b>
240
297
       Deliveries to external files  and  external  commands  are
241
298
       made with the rights of the receiving user on whose behalf
242
299
       the delivery is made.  In the absence of a  user  context,
243
 
       the  <b>local</b>  daemon  uses the owner rights of the <b>:include:</b>
 
300
       the <a href="local.8.html"><b>local</b>(8)</a> daemon uses the owner rights of the <b>:include:</b>
244
301
       file or alias database.  When those files are owned by the
245
302
       superuser, delivery is made with the rights specified with
246
303
       the <b><a href="postconf.5.html#default_privs">default_privs</a></b> configuration parameter.
257
314
       the  postmaster  is notified of bounces and of other trou-
258
315
       ble.
259
316
 
 
317
<b>SECURITY</b>
 
318
       The <a href="local.8.html"><b>local</b>(8)</a> delivery agent needs a dual personality 1) to
 
319
       access the private Postfix queue and IPC mechanisms, 2) to
 
320
       impersonate the recipient and deliver to  recipient-speci-
 
321
       fied  files  or  commands. It is therefore security sensi-
 
322
       tive.
 
323
 
 
324
       The <a href="local.8.html"><b>local</b>(8)</a> delivery agent disallows  regular  expression
 
325
       substitution  of $1 etc. in <b><a href="postconf.5.html#alias_maps">alias_maps</a></b>, because that would
 
326
       open a security hole.
 
327
 
 
328
       The <a href="local.8.html"><b>local</b>(8)</a> delivery agent will silently ignore  requests
 
329
       to  use  the <a href="proxymap.8.html"><b>proxymap</b>(8)</a> server within <b><a href="postconf.5.html#alias_maps">alias_maps</a></b>. Instead
 
330
       it will open the table directly.  Before  Postfix  version
 
331
       2.2,  the  <a href="local.8.html"><b>local</b>(8)</a>  delivery  agent will terminate with a
 
332
       fatal error.
 
333
 
260
334
<b>BUGS</b>
261
335
       For security  reasons,  the  message  delivery  status  of
262
336
       external  commands  or  of  external files is never check-
270
344
 
271
345
<b>CONFIGURATION PARAMETERS</b>
272
346
       Changes  to  <b>main.cf</b>  are  picked  up  automatically,   as
273
 
       <a href="local.8.html">local(8)</a>  processes run for only a limited amount of time.
 
347
       <a href="local.8.html"><b>local</b>(8)</a>  processes run for only a limited amount of time.
274
348
       Use the command "<b>postfix reload</b>" to speed up a change.
275
349
 
276
350
       The text below provides  only  a  parameter  summary.  See
277
 
       <a href="postconf.5.html">postconf(5)</a> for more details including examples.
 
351
       <a href="postconf.5.html"><b>postconf</b>(5)</a> for more details including examples.
278
352
 
279
353
<b>COMPATIBILITY CONTROLS</b>
280
354
       <b><a href="postconf.5.html#biff">biff</a> (yes)</b>
288
362
 
289
363
       <b><a href="postconf.5.html#owner_request_special">owner_request_special</a> (yes)</b>
290
364
              Give special treatment to owner-listname and  list-
291
 
              name-request  address localparts: don't don't split
292
 
              such addresses when the <a href="postconf.5.html#recipient_delimiter">recipient_delimiter</a> is  set
293
 
              to "-".
 
365
              name-request  address  localparts: don't split such
 
366
              addresses when the <a href="postconf.5.html#recipient_delimiter">recipient_delimiter</a>  is  set  to
 
367
              "-".
294
368
 
295
369
       <b><a href="postconf.5.html#sun_mailtool_compatibility">sun_mailtool_compatibility</a> (no)</b>
296
370
              Obsolete SUN mailtool compatibility feature.
297
371
 
298
372
<b>DELIVERY METHOD CONTROLS</b>
299
 
       The  precedence  of <a href="local.8.html">local(8)</a> delivery methods from high to
 
373
       The  precedence  of <a href="local.8.html"><b>local</b>(8)</a> delivery methods from high to
300
374
       low is: aliases, .forward files, <a href="postconf.5.html#mailbox_transport">mailbox_transport</a>,  <a href="postconf.5.html#mailbox_command_maps">mail</a>-
301
375
       <a href="postconf.5.html#mailbox_command_maps">box_command_maps</a>,      <a href="postconf.5.html#mailbox_command">mailbox_command</a>,      <a href="postconf.5.html#home_mailbox">home_mailbox</a>,
302
376
       <a href="postconf.5.html#mail_spool_directory">mail_spool_directory</a>, <a href="postconf.5.html#fallback_transport">fallback_transport</a> and  <a href="postconf.5.html#luser_relay">luser_relay</a>.
303
377
 
304
378
       <b><a href="postconf.5.html#alias_maps">alias_maps</a> (see 'postconf -d' output)</b>
305
 
              The  alias  databases  that  are  used for <a href="local.8.html">local(8)</a>
 
379
              The  alias  databases  that  are  used for <a href="local.8.html"><b>local</b>(8)</a>
306
380
              delivery.
307
381
 
308
382
       <b><a href="postconf.5.html#forward_path">forward_path</a> (see 'postconf -d' output)</b>
309
 
              The <a href="local.8.html">local(8)</a> delivery agent search list for finding
 
383
              The <a href="local.8.html"><b>local</b>(8)</a> delivery agent search list for finding
310
384
              a  .forward file with user-specified delivery meth-
311
385
              ods.
312
386
 
313
387
       <b><a href="postconf.5.html#mailbox_transport">mailbox_transport</a> (empty)</b>
314
388
              Optional  message  delivery  transport   that   the
315
 
              <a href="local.8.html">local(8)</a>  delivery  agent  should  use  for mailbox
 
389
              <a href="local.8.html"><b>local</b>(8)</a>  delivery  agent  should  use  for mailbox
316
390
              delivery to all local recipients,  whether  or  not
317
391
              they are found in the UNIX passwd database.
318
392
 
319
393
       <b><a href="postconf.5.html#mailbox_command_maps">mailbox_command_maps</a> (empty)</b>
320
394
              Optional  lookup tables with per-recipient external
321
 
              commands to use for <a href="local.8.html">local(8)</a> mailbox delivery.
 
395
              commands to use for <a href="local.8.html"><b>local</b>(8)</a> mailbox delivery.
322
396
 
323
397
       <b><a href="postconf.5.html#mailbox_command">mailbox_command</a> (empty)</b>
324
 
              Optional external command that the <a href="local.8.html">local(8)</a>  deliv-
 
398
              Optional external command that the <a href="local.8.html"><b>local</b>(8)</a>  deliv-
325
399
              ery agent should use for mailbox delivery.
326
400
 
327
401
       <b><a href="postconf.5.html#home_mailbox">home_mailbox</a> (empty)</b>
328
402
              Optional  pathname  of a mailbox file relative to a
329
 
              <a href="local.8.html">local(8)</a> user's home directory.
 
403
              <a href="local.8.html"><b>local</b>(8)</a> user's home directory.
330
404
 
331
405
       <b><a href="postconf.5.html#mail_spool_directory">mail_spool_directory</a> (see 'postconf -d' output)</b>
332
 
              The directory where <a href="local.8.html">local(8)</a>  UNIX-style  mailboxes
 
406
              The directory where <a href="local.8.html"><b>local</b>(8)</a>  UNIX-style  mailboxes
333
407
              are kept.
334
408
 
335
409
       <b><a href="postconf.5.html#fallback_transport">fallback_transport</a> (empty)</b>
336
410
              Optional   message   delivery  transport  that  the
337
 
              <a href="local.8.html">local(8)</a> delivery agent should use for  names  that
338
 
              are  not found in the <a href="aliases.5.html">aliases(5)</a> database or in the
 
411
              <a href="local.8.html"><b>local</b>(8)</a> delivery agent should use for  names  that
 
412
              are  not found in the <a href="aliases.5.html"><b>aliases</b>(5)</a> database or in the
339
413
              UNIX passwd database.
340
414
 
341
415
       <b><a href="postconf.5.html#luser_relay">luser_relay</a> (empty)</b>
342
 
              Optional catch-all destination for unknown <a href="local.8.html">local(8)</a>
 
416
              Optional catch-all destination for unknown <a href="local.8.html"><b>local</b>(8)</a>
343
417
              recipients.
344
418
 
 
419
       Available in Postfix version 2.2 and later:
 
420
 
 
421
       <b><a href="postconf.5.html#command_execution_directory">command_execution_directory</a> (empty)</b>
 
422
              The  <a href="local.8.html"><b>local</b>(8)</a>  delivery agent working directory for
 
423
              delivery to external command.
 
424
 
345
425
<b>MAILBOX LOCKING CONTROLS</b>
346
426
       <b><a href="postconf.5.html#deliver_lock_attempts">deliver_lock_attempts</a> (20)</b>
347
427
              The maximal number of attempts to acquire an exclu-
348
 
              sive lock on a mailbox file or <a href="bounce.8.html">bounce(8)</a> logfile.
 
428
              sive lock on a mailbox file or <a href="bounce.8.html"><b>bounce</b>(8)</a> logfile.
349
429
 
350
430
       <b><a href="postconf.5.html#deliver_lock_delay">deliver_lock_delay</a> (1s)</b>
351
 
              The time between attempts to acquire  an  exclusive
352
 
              lock on a mailbox file or <a href="bounce.8.html">bounce(8)</a> logfile.
 
431
              The  time  between attempts to acquire an exclusive
 
432
              lock on a mailbox file or <a href="bounce.8.html"><b>bounce</b>(8)</a> logfile.
353
433
 
354
434
       <b><a href="postconf.5.html#stale_lock_time">stale_lock_time</a> (500s)</b>
355
 
              The  time  after  which  a  stale exclusive mailbox
 
435
              The time after  which  a  stale  exclusive  mailbox
356
436
              lockfile is removed.
357
437
 
358
438
       <b><a href="postconf.5.html#mailbox_delivery_lock">mailbox_delivery_lock</a> (see 'postconf -d' output)</b>
359
 
              How to lock a UNIX-style  <a href="local.8.html">local(8)</a>  mailbox  before
 
439
              How  to  lock  a UNIX-style <a href="local.8.html"><b>local</b>(8)</a> mailbox before
360
440
              attempting delivery.
361
441
 
362
442
<b>RESOURCE AND RATE CONTROLS</b>
364
444
              Time limit for delivery to external commands.
365
445
 
366
446
       <b><a href="postconf.5.html#duplicate_filter_limit">duplicate_filter_limit</a> (1000)</b>
367
 
              The  maximal  number of addresses remembered by the
368
 
              address duplicate filter  for  <a href="aliases.5.html">aliases(5)</a>  or  vir-
369
 
              tual(5) alias expansion, or for <a href="showq.8.html">showq(8)</a> queue dis-
 
447
              The maximal number of addresses remembered  by  the
 
448
              address  duplicate  filter  for  <a href="aliases.5.html"><b>aliases</b>(5)</a> or <a href="virtual.5.html"><b>vir-</b></a>
 
449
              <a href="virtual.5.html"><b>tual</b>(5)</a> alias expansion, or for <a href="showq.8.html"><b>showq</b>(8)</a> queue dis-
370
450
              plays.
371
451
 
372
452
       <b><a href="postconf.5.html#local_destination_concurrency_limit">local_destination_concurrency_limit</a> (2)</b>
373
 
              The maximal number of parallel deliveries  via  the
 
453
              The  maximal  number of parallel deliveries via the
374
454
              local mail delivery transport to the same recipient
375
 
              (when "<a href="postconf.5.html#local_destination_recipient_limit">local_destination_recipient_limit</a> =  1")  or
376
 
              the  maximal  number  of parallel deliveries to the
377
 
              same <a href="ADDRESS_CLASS_README.html#local_domain_class">local domain</a> (when  "local_destination_recipi-
 
455
              (when  "<a href="postconf.5.html#local_destination_recipient_limit">local_destination_recipient_limit</a>  = 1") or
 
456
              the maximal number of parallel  deliveries  to  the
 
457
              same  <a href="ADDRESS_CLASS_README.html#local_domain_class">local domain</a> (when "local_destination_recipi-
378
458
              ent_limit &gt; 1").
379
459
 
380
460
       <b><a href="postconf.5.html#local_destination_recipient_limit">local_destination_recipient_limit</a> (1)</b>
382
462
              ery via the local mail delivery transport.
383
463
 
384
464
       <b><a href="postconf.5.html#mailbox_size_limit">mailbox_size_limit</a> (51200000)</b>
385
 
              The maximal size of any <a href="local.8.html">local(8)</a> individual mailbox
 
465
              The maximal size of any <a href="local.8.html"><b>local</b>(8)</a> individual mailbox
386
466
              or maildir file, or zero (no limit).
387
467
 
388
468
<b>SECURITY CONTROLS</b>
389
469
       <b><a href="postconf.5.html#allow_mail_to_commands">allow_mail_to_commands</a> (alias, forward)</b>
390
 
              Restrict  <a href="local.8.html">local(8)</a>  mail  delivery to external com-
 
470
              Restrict <a href="local.8.html"><b>local</b>(8)</a> mail delivery  to  external  com-
391
471
              mands.
392
472
 
393
473
       <b><a href="postconf.5.html#allow_mail_to_files">allow_mail_to_files</a> (alias, forward)</b>
394
 
              Restrict <a href="local.8.html">local(8)</a> mail delivery to external  files.
 
474
              Restrict  <a href="local.8.html"><b>local</b>(8)</a> mail delivery to external files.
395
475
 
396
476
       <b><a href="postconf.5.html#command_expansion_filter">command_expansion_filter</a> (see 'postconf -d' output)</b>
397
 
              Restrict  the characters that the <a href="local.8.html">local(8)</a> delivery
398
 
              agent allows in $name expansions  of  $mailbox_com-
 
477
              Restrict the characters that the <a href="local.8.html"><b>local</b>(8)</a>  delivery
 
478
              agent  allows  in $name expansions of $mailbox_com-
399
479
              mand.
400
480
 
401
481
       <b><a href="postconf.5.html#default_privs">default_privs</a> (nobody)</b>
402
 
              The  default  rights  used by the <a href="local.8.html">local(8)</a> delivery
 
482
              The default rights used by  the  <a href="local.8.html"><b>local</b>(8)</a>  delivery
403
483
              agent for delivery to external file or command.
404
484
 
405
485
       <b><a href="postconf.5.html#forward_expansion_filter">forward_expansion_filter</a> (see 'postconf -d' output)</b>
406
 
              Restrict the characters that the <a href="local.8.html">local(8)</a>  delivery
407
 
              agent  allows in $name expansions of $<a href="postconf.5.html#forward_path">forward_path</a>.
 
486
              Restrict  the characters that the <a href="local.8.html"><b>local</b>(8)</a> delivery
 
487
              agent allows in $name expansions of  $<a href="postconf.5.html#forward_path">forward_path</a>.
 
488
 
 
489
       Available in Postfix version 2.2 and later:
 
490
 
 
491
       <b><a href="postconf.5.html#execution_directory_expansion_filter">execution_directory_expansion_filter</a>  (see  'postconf  -d'</b>
 
492
       <b>output)</b>
 
493
              Restrict  the characters that the <a href="local.8.html"><b>local</b>(8)</a> delivery
 
494
              agent allows in $name expansions of $<a href="postconf.5.html#command_execution_directory">command_execu</a>-
 
495
              <a href="postconf.5.html#command_execution_directory">tion_directory</a>.
408
496
 
409
497
<b>MISCELLANEOUS CONTROLS</b>
410
498
       <b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b>
411
 
              The default location of  the  Postfix  main.cf  and
 
499
              The  default  location  of  the Postfix main.cf and
412
500
              master.cf configuration files.
413
501
 
414
502
       <b><a href="postconf.5.html#daemon_timeout">daemon_timeout</a> (18000s)</b>
415
 
              How  much time a Postfix daemon process may take to
416
 
              handle a request  before  it  is  terminated  by  a
 
503
              How much time a Postfix daemon process may take  to
 
504
              handle  a  request  before  it  is  terminated by a
417
505
              built-in watchdog timer.
418
506
 
419
507
       <b><a href="postconf.5.html#export_environment">export_environment</a> (see 'postconf -d' output)</b>
420
 
              The  list  of  environment variables that a Postfix
 
508
              The list of environment variables  that  a  Postfix
421
509
              process will export to non-Postfix processes.
422
510
 
423
511
       <b><a href="postconf.5.html#ipc_timeout">ipc_timeout</a> (3600s)</b>
425
513
              over an internal communication channel.
426
514
 
427
515
       <b><a href="postconf.5.html#local_command_shell">local_command_shell</a> (empty)</b>
428
 
              Optional  shell  program  for  <a href="local.8.html">local(8)</a> delivery to
 
516
              Optional shell program  for  <a href="local.8.html"><b>local</b>(8)</a>  delivery  to
429
517
              non-Postfix command.
430
518
 
431
519
       <b><a href="postconf.5.html#max_idle">max_idle</a> (100s)</b>
432
 
              The maximum amount of time  that  an  idle  Postfix
433
 
              daemon  process  waits for the next service request
 
520
              The  maximum  amount  of  time that an idle Postfix
 
521
              daemon process waits for the next  service  request
434
522
              before exiting.
435
523
 
436
524
       <b><a href="postconf.5.html#max_use">max_use</a> (100)</b>
437
 
              The maximal number of connection requests before  a
 
525
              The  maximal number of connection requests before a
438
526
              Postfix daemon process terminates.
439
527
 
440
528
       <b><a href="postconf.5.html#prepend_delivered_header">prepend_delivered_header</a> (command, file, forward)</b>
441
 
              The  message  delivery  contexts  where the Postfix
442
 
              <a href="local.8.html">local(8)</a> delivery agent  prepends  a  Delivered-To:
 
529
              The message delivery  contexts  where  the  Postfix
 
530
              <a href="local.8.html"><b>local</b>(8)</a>  delivery  agent  prepends a Delivered-To:
443
531
              message header.
444
532
 
445
533
       <b><a href="postconf.5.html#process_id">process_id</a> (read-only)</b>
446
 
              The  process ID of a Postfix command or daemon pro-
447
 
              cess.
 
534
              The process ID  of  a  Postfix  command  or  daemon
 
535
              process.
448
536
 
449
537
       <b><a href="postconf.5.html#process_name">process_name</a> (read-only)</b>
450
 
              The process name of a  Postfix  command  or  daemon
 
538
              The  process  name  of  a Postfix command or daemon
451
539
              process.
452
540
 
453
541
       <b><a href="postconf.5.html#propagate_unmatched_extensions">propagate_unmatched_extensions</a> (canonical, virtual)</b>
454
 
              What  address  lookup tables copy an address exten-
 
542
              What address lookup tables copy an  address  exten-
455
543
              sion from the lookup key to the lookup result.
456
544
 
457
545
       <b><a href="postconf.5.html#queue_directory">queue_directory</a> (see 'postconf -d' output)</b>
458
 
              The location of the Postfix top-level queue  direc-
 
546
              The  location of the Postfix top-level queue direc-
459
547
              tory.
460
548
 
461
549
       <b><a href="postconf.5.html#recipient_delimiter">recipient_delimiter</a> (empty)</b>
463
551
              sions (user+foo).
464
552
 
465
553
       <b><a href="postconf.5.html#require_home_directory">require_home_directory</a> (no)</b>
466
 
              Whether or not a <a href="local.8.html">local(8)</a> recipient's  home  direc-
467
 
              tory  must exist before mail delivery is attempted.
 
554
              Whether  or  not a <a href="local.8.html"><b>local</b>(8)</a> recipient's home direc-
 
555
              tory must exist before mail delivery is  attempted.
468
556
 
469
557
       <b><a href="postconf.5.html#syslog_facility">syslog_facility</a> (mail)</b>
470
558
              The syslog facility of Postfix logging.
471
559
 
472
560
       <b><a href="postconf.5.html#syslog_name">syslog_name</a> (postfix)</b>
473
 
              The mail system name that is prepended to the  pro-
474
 
              cess  name  in  syslog  records,  so  that  "smtpd"
 
561
              The  mail  system  name  that  is  prepended to the
 
562
              process name in syslog  records,  so  that  "smtpd"
475
563
              becomes, for example, "postfix/smtpd".
476
564
 
477
565
<b>FILES</b>
478
566
       The following are examples; details differ between systems.
479
567
       $HOME/.forward, per-user aliasing
480
 
       /etc/aliases, sytem-wide alias database
 
568
       /etc/aliases, system-wide alias database
481
569
       /var/spool/mail, system mailboxes
482
570
 
483
571
<b>SEE ALSO</b>
487
575
       <a href="postalias.1.html">postalias(1)</a>, create/update alias database
488
576
       <a href="aliases.5.html">aliases(5)</a>, format of alias database
489
577
       <a href="postconf.5.html">postconf(5)</a>, configuration parameters
 
578
       <a href="master.5.html">master(5)</a>, generic daemon options
490
579
       syslogd(8), system logging
491
580
 
492
581
<b>LICENSE</b>
493
 
       The Secure Mailer license must be  distributed  with  this
 
582
       The  Secure  Mailer  license must be distributed with this
494
583
       software.
495
584
 
496
585
<b>HISTORY</b>
497
586
       The <b>Delivered-To:</b> message header appears in the <b>qmail</b> sys-
498
587
       tem by Daniel Bernstein.
499
588
 
500
 
       The <i>maildir</i> structure  appears  in  the  <b>qmail</b>  system  by
 
589
       The  <i>maildir</i>  structure  appears  in  the  <b>qmail</b> system by
501
590
       Daniel Bernstein.
502
591
 
503
592
<b>AUTHOR(S)</b>
506
595
       P.O. Box 704
507
596
       Yorktown Heights, NY 10598, USA
508
597
 
509
 
                                                         LOCAL(8)
 
598
                                                                      LOCAL(8)
510
599
</pre> </body> </html>