~ubuntu-branches/ubuntu/dapper/postfix/dapper-security

« back to all changes in this revision

Viewing changes to man/man8/cleanup.8

  • Committer: Bazaar Package Importer
  • Author(s): LaMont Jones
  • Date: 2005-02-27 09:33:07 UTC
  • Revision ID: james.westby@ubuntu.com-20050227093307-cn789t27ibnlh6tf
Tags: upstream-2.1.5
ImportĀ upstreamĀ versionĀ 2.1.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH CLEANUP 8 
 
2
.ad
 
3
.fi
 
4
.SH NAME
 
5
cleanup
 
6
\-
 
7
canonicalize and enqueue Postfix message
 
8
.SH "SYNOPSIS"
 
9
.na
 
10
.nf
 
11
\fBcleanup\fR [generic Postfix daemon options]
 
12
.SH DESCRIPTION
 
13
.ad
 
14
.fi
 
15
The \fBcleanup\fR daemon processes inbound mail, inserts it
 
16
into the \fBincoming\fR mail queue, and informs the queue
 
17
manager of its arrival.
 
18
 
 
19
The \fBcleanup\fR daemon always performs the following transformations:
 
20
.IP \(bu
 
21
Insert missing message headers: (\fBResent-\fR) \fBFrom:\fR,
 
22
\fBTo:\fR, \fBMessage-Id:\fR, and \fBDate:\fR.
 
23
.IP \(bu
 
24
Transform envelope and header addresses to the standard
 
25
\fIuser@fully-qualified-domain\fR form that is expected by other
 
26
Postfix programs.
 
27
This task is delegated to the \fBtrivial-rewrite\fR(8) daemon.
 
28
.IP \(bu
 
29
Eliminate duplicate envelope recipient addresses.
 
30
.PP
 
31
The following address transformations are optional:
 
32
.IP \(bu
 
33
Optionally, rewrite all envelope and header addresses according
 
34
to the mappings specified in the \fBcanonical\fR(5) lookup tables.
 
35
.IP \(bu
 
36
Optionally, masquerade envelope sender addresses and message
 
37
header addresses (i.e. strip host or domain information below
 
38
all domains listed in the \fBmasquerade_domains\fR parameter,
 
39
except for user names listed in \fBmasquerade_exceptions\fR).
 
40
By default, address masquerading does not affect envelope recipients.
 
41
.IP \(bu
 
42
Optionally, expand envelope recipients according to information
 
43
found in the \fBvirtual\fR(5) lookup tables.
 
44
.PP
 
45
The \fBcleanup\fR daemon performs sanity checks on the content of
 
46
each message. When it finds a problem, by default it returns a
 
47
diagnostic status to the client, and leaves it up to the client
 
48
to deal with the problem. Alternatively, the client can request
 
49
the \fBcleanup\fR daemon to bounce the message back to the sender
 
50
in case of trouble.
 
51
.SH "STANDARDS"
 
52
.na
 
53
.nf
 
54
RFC 822 (ARPA Internet Text Messages)
 
55
RFC 2045 (MIME: Format of Internet Message Bodies)
 
56
RFC 2046 (MIME: Media Types)
 
57
.SH DIAGNOSTICS
 
58
.ad
 
59
.fi
 
60
Problems and transactions are logged to \fBsyslogd\fR(8).
 
61
.SH BUGS
 
62
.ad
 
63
.fi
 
64
Table-driven rewriting rules make it hard to express \fBif then
 
65
else\fR and other logical relationships.
 
66
.SH "CONFIGURATION PARAMETERS"
 
67
.na
 
68
.nf
 
69
.ad
 
70
.fi
 
71
Changes to \fBmain.cf\fR are picked up automatically, as cleanup(8)
 
72
processes run for only a limited amount of time. Use the command
 
73
"\fBpostfix reload\fR" to speed up a change.
 
74
 
 
75
The text below provides only a parameter summary. See
 
76
postconf(5) for more details including examples.
 
77
.SH "COMPATIBILITY CONTROLS"
 
78
.na
 
79
.nf
 
80
.ad
 
81
.fi
 
82
.IP "\fBundisclosed_recipients_header (To: undisclosed-recipients:;)\fR"
 
83
Message header that the Postfix cleanup(8) server inserts when a
 
84
message contains no To: or Cc: message header.
 
85
.PP
 
86
Available in Postfix version 2.1 and later:
 
87
.IP "\fBenable_errors_to (no)\fR"
 
88
Report mail delivery errors to the address specified with the
 
89
non-standard Errors-To: message header, instead of the envelope
 
90
sender address.
 
91
.SH "BUILT-IN CONTENT FILTERING CONTROLS"
 
92
.na
 
93
.nf
 
94
.ad
 
95
.fi
 
96
Postfix built-in content filtering is meant to stop a flood of
 
97
worms or viruses. It is not a general content filter.
 
98
.IP "\fBbody_checks (empty)\fR"
 
99
Optional lookup tables for content inspection as specified in
 
100
the body_checks(5) manual page.
 
101
.IP "\fBheader_checks (empty)\fR"
 
102
Optional lookup tables for content inspection of primary non-MIME
 
103
message headers, as specified in the header_checks(5) manual page.
 
104
.PP
 
105
Available in Postfix version 2.0 and later:
 
106
.IP "\fBbody_checks_size_limit (51200)\fR"
 
107
How much text in a message body segment (or attachment, if you
 
108
prefer to use that term) is subjected to body_checks inspection.
 
109
.IP "\fBmime_header_checks ($header_checks)\fR"
 
110
Optional lookup tables for content inspection of MIME related
 
111
message headers, as described in the header_checks(5) manual page.
 
112
.IP "\fBnested_header_checks ($header_checks)\fR"
 
113
Optional lookup tables for content inspection of non-MIME message
 
114
headers in attached messages, as described in the header_checks(5)
 
115
manual page.
 
116
.SH "MIME PROCESSING CONTROLS"
 
117
.na
 
118
.nf
 
119
.ad
 
120
.fi
 
121
Available in Postfix version 2.0 and later:
 
122
.IP "\fBdisable_mime_input_processing (no)\fR"
 
123
Turn off MIME processing while receiving mail.
 
124
.IP "\fBmime_boundary_length_limit (2048)\fR"
 
125
The maximal length of MIME multipart boundary strings.
 
126
.IP "\fBmime_nesting_limit (100)\fR"
 
127
The maximal nesting level of multipart mail that the MIME processor
 
128
will handle.
 
129
.IP "\fBstrict_8bitmime (no)\fR"
 
130
Enable both strict_7bit_headers and strict_8bitmime_body.
 
131
.IP "\fBstrict_7bit_headers (no)\fR"
 
132
Reject mail with 8-bit text in message headers.
 
133
.IP "\fBstrict_8bitmime_body (no)\fR"
 
134
Reject 8-bit message body text without 8-bit MIME content encoding
 
135
information.
 
136
.IP "\fBstrict_mime_encoding_domain (no)\fR"
 
137
Reject mail with invalid Content-Transfer-Encoding: information
 
138
for the message/* or multipart/* MIME content types.
 
139
.SH "AUTOMATIC BCC RECIPIENT CONTROLS"
 
140
.na
 
141
.nf
 
142
.ad
 
143
.fi
 
144
Postfix can automatically add BCC (blind carbon copy)
 
145
when mail enters the mail system:
 
146
.IP "\fBalways_bcc (empty)\fR"
 
147
Optional address that receives a "blind carbon copy" of each message
 
148
that is received by the Postfix mail system.
 
149
.PP
 
150
Available in Postfix version 2.1 and later:
 
151
.IP "\fBsender_bcc_maps (empty)\fR"
 
152
Optional BCC (blind carbon-copy) address lookup tables, indexed
 
153
by sender address.
 
154
.IP "\fBrecipient_bcc_maps (empty)\fR"
 
155
Optional BCC (blind carbon-copy) address lookup tables, indexed by
 
156
recipient address.
 
157
.SH "ADDRESS TRANSFORMATION CONTROLS"
 
158
.na
 
159
.nf
 
160
.ad
 
161
.fi
 
162
Address rewriting is delegated to the trivial-rewrite(8) daemon.
 
163
The cleanup(8) server implements table driven address mapping.
 
164
.IP "\fBempty_address_recipient (MAILER-DAEMON)\fR"
 
165
The recipient of mail addressed to the null address.
 
166
.IP "\fBcanonical_maps (empty)\fR"
 
167
Optional address mapping lookup tables for message headers and
 
168
envelopes.
 
169
.IP "\fBrecipient_canonical_maps (empty)\fR"
 
170
Optional address mapping lookup tables for envelope and header
 
171
recipient addresses.
 
172
.IP "\fBsender_canonical_maps (empty)\fR"
 
173
Optional address mapping lookup tables for envelope and header
 
174
sender addresses.
 
175
.IP "\fBmasquerade_classes (envelope_sender, header_sender, header_recipient)\fR"
 
176
What addresses are subject to address masquerading.
 
177
.IP "\fBmasquerade_domains (empty)\fR"
 
178
Optional list of domains whose subdomain structure will be stripped
 
179
off in email addresses.
 
180
.IP "\fBmasquerade_exceptions (empty)\fR"
 
181
Optional list of user names that are not subjected to address
 
182
masquerading, even when their address matches $masquerade_domains.
 
183
.IP "\fBpropagate_unmatched_extensions (canonical, virtual)\fR"
 
184
What address lookup tables copy an address extension from the lookup
 
185
key to the lookup result.
 
186
.PP
 
187
Available before Postfix version 2.0:
 
188
.IP "\fBvirtual_maps (empty)\fR"
 
189
Optional lookup tables with a) names of domains for which all
 
190
addresses are aliased to addresses in other local or remote domains,
 
191
and b) addresses that are aliased to addresses in other local or
 
192
remote domains.
 
193
.PP
 
194
Available in Postfix version 2.0 and later:
 
195
.IP "\fBvirtual_alias_maps ($virtual_maps)\fR"
 
196
Optional lookup tables that alias specific mail addresses or domains
 
197
to other local or remote address.
 
198
.SH "RESOURCE AND RATE CONTROLS"
 
199
.na
 
200
.nf
 
201
.ad
 
202
.fi
 
203
.IP "\fBduplicate_filter_limit (1000)\fR"
 
204
The maximal number of addresses remembered by the address
 
205
duplicate filter for aliases(5) or virtual(5) alias expansion, or
 
206
for showq(8) queue displays.
 
207
.IP "\fBheader_size_limit (102400)\fR"
 
208
The maximal amount of memory in bytes for storing a message header.
 
209
.IP "\fBhopcount_limit (50)\fR"
 
210
The maximal number of Received:  message headers that is allowed
 
211
in the primary message headers.
 
212
.IP "\fBin_flow_delay (1s)\fR"
 
213
Time to pause before accepting a new message, when the message
 
214
arrival rate exceeds the message delivery rate.
 
215
.IP "\fBmessage_size_limit (10240000)\fR"
 
216
The maximal size in bytes of a message, including envelope information.
 
217
.PP
 
218
Available in Postfix version 2.0 and later:
 
219
.IP "\fBheader_address_token_limit (10240)\fR"
 
220
The maximal number of address tokens are allowed in an address
 
221
message header.
 
222
.IP "\fBmime_boundary_length_limit (2048)\fR"
 
223
The maximal length of MIME multipart boundary strings.
 
224
.IP "\fBmime_nesting_limit (100)\fR"
 
225
The maximal nesting level of multipart mail that the MIME processor
 
226
will handle.
 
227
.IP "\fBqueue_file_attribute_count_limit (100)\fR"
 
228
The maximal number of (name=value) attributes that may be stored
 
229
in a Postfix queue file.
 
230
.PP
 
231
Available in Postfix version 2.1 and later:
 
232
.IP "\fBvirtual_alias_expansion_limit (1000)\fR"
 
233
The maximal number of addresses that virtual alias expansion produces
 
234
from each original recipient.
 
235
.IP "\fBvirtual_alias_recursion_limit (1000)\fR"
 
236
The maximal nesting depth of virtual alias expansion.
 
237
.SH "MISCELLANEOUS CONTROLS"
 
238
.na
 
239
.nf
 
240
.ad
 
241
.fi
 
242
.IP "\fBconfig_directory (see 'postconf -d' output)\fR"
 
243
The default location of the Postfix main.cf and master.cf
 
244
configuration files.
 
245
.IP "\fBdaemon_timeout (18000s)\fR"
 
246
How much time a Postfix daemon process may take to handle a
 
247
request before it is terminated by a built-in watchdog timer.
 
248
.IP "\fBdelay_warning_time (0h)\fR"
 
249
The time after which the sender receives the message headers of
 
250
mail that is still queued.
 
251
.IP "\fBipc_timeout (3600s)\fR"
 
252
The time limit for sending or receiving information over an internal
 
253
communication channel.
 
254
.IP "\fBmax_idle (100s)\fR"
 
255
The maximum amount of time that an idle Postfix daemon process
 
256
waits for the next service request before exiting.
 
257
.IP "\fBmax_use (100)\fR"
 
258
The maximal number of connection requests before a Postfix daemon
 
259
process terminates.
 
260
.IP "\fBmyhostname (see 'postconf -d' output)\fR"
 
261
The internet hostname of this mail system.
 
262
.IP "\fBmyorigin ($myhostname)\fR"
 
263
The default domain name that locally-posted mail appears to come
 
264
from, and that locally posted mail is delivered to.
 
265
.IP "\fBprocess_id (read-only)\fR"
 
266
The process ID of a Postfix command or daemon process.
 
267
.IP "\fBprocess_name (read-only)\fR"
 
268
The process name of a Postfix command or daemon process.
 
269
.IP "\fBqueue_directory (see 'postconf -d' output)\fR"
 
270
The location of the Postfix top-level queue directory.
 
271
.IP "\fBsoft_bounce (no)\fR"
 
272
Safety net to keep mail queued that would otherwise be returned to
 
273
the sender.
 
274
.IP "\fBsyslog_facility (mail)\fR"
 
275
The syslog facility of Postfix logging.
 
276
.IP "\fBsyslog_name (postfix)\fR"
 
277
The mail system name that is prepended to the process name in syslog
 
278
records, so that "smtpd" becomes, for example, "postfix/smtpd".
 
279
.PP
 
280
Available in Postfix version 2.1 and later:
 
281
.IP "\fBenable_original_recipient (yes)\fR"
 
282
Enable support for the X-Original-To message header.
 
283
.SH "FILES"
 
284
.na
 
285
.nf
 
286
/etc/postfix/canonical*, canonical mapping table
 
287
/etc/postfix/virtual*, virtual mapping table
 
288
.SH "SEE ALSO"
 
289
.na
 
290
.nf
 
291
trivial-rewrite(8), address rewriting
 
292
qmgr(8), queue manager
 
293
header_checks(5), message header content inspection
 
294
body_checks(5), body parts content inspection
 
295
canonical(5), canonical address lookup table format
 
296
virtual(5), virtual alias lookup table format
 
297
postconf(5), configuration parameters
 
298
master(8), process manager
 
299
syslogd(8), system logging
 
300
.SH "README FILES"
 
301
.na
 
302
.nf
 
303
.ad
 
304
.fi
 
305
Use "\fBpostconf readme_directory\fR" or
 
306
"\fBpostconf html_directory\fR" to locate this information.
 
307
.na
 
308
.nf
 
309
ADDRESS_REWRITING_README Postfix address manipulation
 
310
.SH "LICENSE"
 
311
.na
 
312
.nf
 
313
.ad
 
314
.fi
 
315
The Secure Mailer license must be distributed with this software.
 
316
.SH "AUTHOR(S)"
 
317
.na
 
318
.nf
 
319
Wietse Venema
 
320
IBM T.J. Watson Research
 
321
P.O. Box 704
 
322
Yorktown Heights, NY 10598, USA