← Back to branch summary

~ubuntu-branches/ubuntu/vivid/postfix/vivid-proposed

« back to all changes in this revision

Viewing changes to man/man8/pipe.8

Tags: upstream-2.2.6
Import upstream version 2.2.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/man8/pipe.8
12
12
.SH DESCRIPTION
13
13
.ad
14
14
.fi
15
 
The \fBpipe\fR daemon processes requests from the Postfix queue
 
15
The \fBpipe\fR(8) daemon processes requests from the Postfix queue
16
16
manager to deliver messages to external commands.
17
17
This program expects to be run from the \fBmaster\fR(8) process
18
18
manager.
21
21
next-hop host name can be specified as command-line macros that are
22
22
expanded before the external command is executed.
23
23
 
24
 
The \fBpipe\fR daemon updates queue files and marks recipients
 
24
The \fBpipe\fR(8) daemon updates queue files and marks recipients
25
25
as finished, or it informs the queue manager that delivery should
26
26
be tried again at a later time. Delivery status reports are sent
27
27
to the \fBbounce\fR(8), \fBdefer\fR(8) or \fBtrace\fR(8) daemon as
51
51
.fi
52
52
The external command attributes are given in the \fBmaster.cf\fR
53
53
file at the end of a service definition.  The syntax is as follows:
 
54
.IP "\fBdirectory=\fIpathname\fR (optional, default: \fB$queue_directory\fR)"
 
55
Change to the named directory before executing the external command.
 
56
Delivery is deferred in case of failure.
 
57
.sp
 
58
This feature is available as of Postfix 2.2.
 
59
.IP "\fBeol=string\fR (optional, default: \fB\en\fR)"
 
60
The output record delimiter. Typically one would use either
 
61
\fB\er\en\fR or \fB\en\fR. The usual C-style backslash escape
 
62
sequences are recognized: \fB\ea \eb \ef \en \er \et \ev
 
63
\e\fIddd\fR (up to three octal digits) and \fB\e\e\fR.
54
64
.IP "\fBflags=BDFORhqu.>\fR (optional)"
55
65
Optional message processing flags. By default, a message is
56
66
copied unchanged.
63
73
Prepend a "\fBDelivered-To: \fIrecipient\fR" message header with the
64
74
envelope recipient address. Note: for this to work, the
65
75
\fItransport\fB_destination_recipient_limit\fR must be 1.
 
76
.sp
 
77
This feature is available as of Postfix 2.0.
66
78
.IP \fBF\fR
67
79
Prepend a "\fBFrom \fIsender time_stamp\fR" envelope header to
68
80
the message content.
71
83
Prepend an "\fBX-Original-To: \fIrecipient\fR" message header
72
84
with the recipient address as given to Postfix. Note: for this to
73
85
work, the \fItransport\fB_destination_recipient_limit\fR must be 1.
 
86
.sp
 
87
This feature is available as of Postfix 2.0.
74
88
.IP \fBR\fR
75
89
Prepend a \fBReturn-Path:\fR message header with the envelope sender
76
90
address.
86
100
This is recommended for delivery via \fBUUCP\fR or \fBBSMTP\fR.
87
101
.sp
88
102
The result is compatible with the address parsing of command-line
89
 
recipients by the Postfix \fBsendmail\fR mail submission command.
 
103
recipients by the Postfix \fBsendmail\fR(1) mail submission command.
90
104
.sp
91
105
The \fBq\fR flag affects only entire addresses, not the partial
92
106
address information from the \fB$user\fR, \fB$extension\fR or
96
110
the left of the right-most \fB@\fR character) to lower case.
97
111
This is recommended for delivery via \fBUUCP\fR.
98
112
.IP \fB.\fR
99
 
Prepend \fB.\fR to lines starting with "\fB.\fR". This is needed
 
113
Prepend "\fB.\fR" to lines starting with "\fB.\fR". This is needed
100
114
by, for example, \fBBSMTP\fR software.
101
115
.IP \fB>\fR
102
 
Prepend \fB>\fR to lines starting with "\fBFrom \fR". This is expected
 
116
Prepend "\fB>\fR" to lines starting with "\fBFrom \fR". This is expected
103
117
by, for example, \fBUUCP\fR software.
104
118
.RE
 
119
.IP "\fBsize\fR=\fIsize_limit\fR (optional)"
 
120
Messages greater in size than this limit (in bytes) will be bounced
 
121
back to the sender.
105
122
.IP "\fBuser\fR=\fIusername\fR (required)"
106
123
.IP "\fBuser\fR=\fIusername\fR:\fIgroupname\fR"
107
124
The external command is executed with the rights of the
110
127
mail system owner. If \fIgroupname\fR is specified, the
111
128
corresponding group ID is used instead of the group ID of
112
129
\fIusername\fR.
113
 
.IP "\fBeol=string\fR (optional, default: \fB\en\fR)"
114
 
The output record delimiter. Typically one would use either
115
 
\fB\er\en\fR or \fB\en\fR. The usual C-style backslash escape
116
 
sequences are recognized: \fB\ea \eb \ef \en \er \et \ev
117
 
\e\fIoctal\fR and \fB\e\e\fR.
118
 
.IP "\fBsize\fR=\fIsize_limit\fR (optional)"
119
 
Messages greater in size than this limit (in bytes) will be bounced
120
 
back to the sender.
121
130
.IP "\fBargv\fR=\fIcommand\fR... (required)"
122
131
The command to be executed. This must be specified as the
123
132
last command attribute.
126
135
.sp
127
136
In the command argument vector, the following macros are recognized
128
137
and replaced with corresponding information from the Postfix queue
129
 
manager delivery request:
 
138
manager delivery request.
 
139
.sp
 
140
In addition to the form ${\fIname\fR}, the forms $\fIname\fR and
 
141
$(\fIname\fR) are also recognized.  Specify \fB$$\fR where a single
 
142
\fB$\fR is wanted.
130
143
.RS
 
144
.IP \fB${\fBclient_address\fR}\fR
 
145
This macro expands to the remote client network address.
 
146
.sp
 
147
This is available in Postfix 2.2 and later.
 
148
.IP \fB${\fBclient_helo\fR}\fR
 
149
This macro expands to the remote client HELO command parameter.
 
150
.sp
 
151
This is available in Postfix 2.2 and later.
 
152
.IP \fB${\fBclient_hostname\fR}\fR
 
153
This macro expands to the remote client hostname.
 
154
.sp
 
155
This is available in Postfix 2.2 and later.
 
156
.IP \fB${\fBclient_protocol\fR}\fR
 
157
This macro expands to the remote client protocol.
 
158
.sp
 
159
This is available in Postfix 2.2 and later.
131
160
.IP \fB${\fBextension\fR}\fR
132
161
This macro expands to the extension part of a recipient address.
133
162
For example, with an address \fIuser+foo@domain\fR the extension is
158
187
.sp
159
188
This information is modified by the \fBhqu\fR flags for quoting
160
189
and case folding.
 
190
.IP \fB${\fBsasl_method\fR}\fR
 
191
This macro expands to the SASL authentication mechanism used
 
192
during the reception of the message. An empty string is passed
 
193
if the message has been received without SASL authentication.
 
194
.sp
 
195
This is available in Postfix 2.2 and later.
 
196
.IP \fB${\fBsasl_sender\fR}\fR
 
197
This macro expands to the SASL sender name (i.e. the original
 
198
submitter as per RFC 2554) used during the reception of the message.
 
199
.sp
 
200
This is available in Postfix 2.2 and later.
 
201
.IP \fB${\fBsasl_username\fR}\fR
 
202
This macro expands to the SASL user name used during the reception
 
203
of the message. An empty string is passed if the message has been
 
204
received without SASL authentication.
 
205
.sp
 
206
This is available in Postfix 2.2 and later.
161
207
.IP \fB${\fBsender\fR}\fR
162
208
This macro expands to the envelope sender address.
163
209
.sp
175
221
.sp
176
222
This information is modified by the \fBu\fR flag for case folding.
177
223
.RE
178
 
.PP
179
 
In addition to the form ${\fIname\fR}, the forms $\fIname\fR and
180
 
$(\fIname\fR) are also recognized.  Specify \fB$$\fR where a single
181
 
\fB$\fR is wanted.
182
224
.SH DIAGNOSTICS
183
225
.ad
184
226
.fi
201
243
.nf
202
244
.ad
203
245
.fi
204
 
Changes to \fBmain.cf\fR are picked up automatically as pipe(8)
 
246
Changes to \fBmain.cf\fR are picked up automatically as \fBpipe\fR(8)
205
247
processes run for only a limited amount of time. Use the command
206
248
"\fBpostfix reload\fR" to speed up a change.
207
249
 
208
250
The text below provides only a parameter summary. See
209
 
postconf(5) for more details including examples.
 
251
\fBpostconf\fR(5) for more details including examples.
210
252
.SH "RESOURCE AND RATE CONTROLS"
211
253
.na
212
254
.nf
271
313
qmgr(8), queue manager
272
314
bounce(8), delivery status reports
273
315
postconf(5), configuration parameters
 
316
master(5), generic daemon options
274
317
master(8), process manager
275
318
syslogd(8), system logging
276
319
.SH "LICENSE"