1CLEANUP(8) System Manager's Manual CLEANUP(8)
2
6 cleanup - canonicalize and enqueue Postfix message
7
9 cleanup [generic Postfix daemon options]
10
12 The cleanup(8) daemon processes inbound mail, inserts it into the
13 incoming mail queue, and informs the queue manager of its arrival.
14 The cleanup(8) daemon always performs the following transformations:
16 · Insert missing message headers: (Resent-) From:, To:, Mes‐
18 sage-Id:, and Date:.
19 · Transform envelope and header addresses to the standard
21 user@fully-qualified-domain form that is expected by other Post‐
22 fix programs. This task is delegated to the trivial-rewrite(8)
23 daemon.
24 · Eliminate duplicate envelope recipient addresses.
26 · Remove message headers: Bcc, Content-Length, Resent-Bcc,
28 Return-Path.
29 The following address transformations are optional:
31 · Optionally, rewrite all envelope and header addresses according
33 to the mappings specified in the canonical(5) lookup tables.
34 · Optionally, masquerade envelope sender addresses and message
36 header addresses (i.e. strip host or domain information below
37 all domains listed in the masquerade_domains parameter, except
38 for user names listed in masquerade_exceptions). By default,
39 address masquerading does not affect envelope recipients.
40 · Optionally, expand envelope recipients according to information
42 found in the virtual(5) lookup tables.
43 The cleanup(8) daemon performs sanity checks on the content of each
45 message. When it finds a problem, by default it returns a diagnostic
46 status to the client, and leaves it up to the client to deal with the
47 problem. Alternatively, the client can request the cleanup(8) daemon to
48 bounce the message back to the sender in case of trouble.
49
51 RFC 822 (ARPA Internet Text Messages)
52 RFC 2045 (MIME: Format of Internet Message Bodies)
53 RFC 2046 (MIME: Media Types)
54 RFC 2822 (Internet Message Format)
55 RFC 3463 (Enhanced Status Codes)
56 RFC 3464 (Delivery status notifications)
57 RFC 5322 (Internet Message Format)
58
60 Problems and transactions are logged to syslogd(8) or postlogd(8).
61
63 Table-driven rewriting rules make it hard to express if then else and
64 other logical relationships.
65
67 Changes to main.cf are picked up automatically, as cleanup(8) processes
68 run for only a limited amount of time. Use the command "postfix reload"
69 to speed up a change.
70 The text below provides only a parameter summary. See postconf(5) for
72 more details including examples.
73
75 undisclosed_recipients_header (see 'postconf -d' output)
76 Message header that the Postfix cleanup(8) server inserts when a
77 message contains no To: or Cc: message header.
78 Available in Postfix version 2.1 only:
80 enable_errors_to (no)
82 Report mail delivery errors to the address specified with the
83 non-standard Errors-To: message header, instead of the envelope
84 sender address (this feature is removed with Postfix version
85 2.2, is turned off by default with Postfix version 2.1, and is
86 always turned on with older Postfix versions).
87 Available in Postfix version 2.6 and later:
89 always_add_missing_headers (no)
91 Always add (Resent-) From:, To:, Date: or Message-ID: headers
92 when not present.
93 Available in Postfix version 2.9 and later:
95 enable_long_queue_ids (no)
97 Enable long, non-repeating, queue IDs (queue file names).
98 Available in Postfix version 3.0 and later:
100 message_drop_headers (bcc, content-length, resent-bcc, return-path)
102 Names of message headers that the cleanup(8) daemon will remove
103 after applying header_checks(5) and before invoking Milter
104 applications.
105
107 Postfix built-in content filtering is meant to stop a flood of worms or
108 viruses. It is not a general content filter.
109 body_checks (empty)
111 Optional lookup tables for content inspection as specified in
112 the body_checks(5) manual page.
113 header_checks (empty)
115 Optional lookup tables for content inspection of primary
116 non-MIME message headers, as specified in the header_checks(5)
117 manual page.
118 Available in Postfix version 2.0 and later:
120 body_checks_size_limit (51200)
122 How much text in a message body segment (or attachment, if you
123 prefer to use that term) is subjected to body_checks inspection.
124 mime_header_checks ($header_checks)
126 Optional lookup tables for content inspection of MIME related
127 message headers, as described in the header_checks(5) manual
128 page.
129 nested_header_checks ($header_checks)
131 Optional lookup tables for content inspection of non-MIME mes‐
132 sage headers in attached messages, as described in the
133 header_checks(5) manual page.
134 Available in Postfix version 2.3 and later:
136 message_reject_characters (empty)
138 The set of characters that Postfix will reject in message con‐
139 tent.
140 message_strip_characters (empty)
142 The set of characters that Postfix will remove from message con‐
143 tent.
144
146 As of version 2.3, Postfix supports the Sendmail version 8 Milter (mail
147 filter) protocol. When mail is not received via the smtpd(8) server,
148 the cleanup(8) server will simulate SMTP events to the extent that this
149 is possible. For details see the MILTER_README document.
150 non_smtpd_milters (empty)
152 A list of Milter (mail filter) applications for new mail that
153 does not arrive via the Postfix smtpd(8) server.
154 milter_protocol (6)
156 The mail filter protocol version and optional protocol exten‐
157 sions for communication with a Milter application; prior to
158 Postfix 2.6 the default protocol is 2.
159 milter_default_action (tempfail)
161 The default action when a Milter (mail filter) application is
162 unavailable or mis-configured.
163 milter_macro_daemon_name ($myhostname)
165 The {daemon_name} macro value for Milter (mail filter) applica‐
166 tions.
167 milter_macro_v ($mail_name $mail_version)
169 The {v} macro value for Milter (mail filter) applications.
170 milter_connect_timeout (30s)
172 The time limit for connecting to a Milter (mail filter) applica‐
173 tion, and for negotiating protocol options.
174 milter_command_timeout (30s)
176 The time limit for sending an SMTP command to a Milter (mail
177 filter) application, and for receiving the response.
178 milter_content_timeout (300s)
180 The time limit for sending message content to a Milter (mail
181 filter) application, and for receiving the response.
182 milter_connect_macros (see 'postconf -d' output)
184 The macros that are sent to Milter (mail filter) applications
185 after completion of an SMTP connection.
186 milter_helo_macros (see 'postconf -d' output)
188 The macros that are sent to Milter (mail filter) applications
189 after the SMTP HELO or EHLO command.
190 milter_mail_macros (see 'postconf -d' output)
192 The macros that are sent to Milter (mail filter) applications
193 after the SMTP MAIL FROM command.
194 milter_rcpt_macros (see 'postconf -d' output)
196 The macros that are sent to Milter (mail filter) applications
197 after the SMTP RCPT TO command.
198 milter_data_macros (see 'postconf -d' output)
200 The macros that are sent to version 4 or higher Milter (mail
201 filter) applications after the SMTP DATA command.
202 milter_unknown_command_macros (see 'postconf -d' output)
204 The macros that are sent to version 3 or higher Milter (mail
205 filter) applications after an unknown SMTP command.
206 milter_end_of_data_macros (see 'postconf -d' output)
208 The macros that are sent to Milter (mail filter) applications
209 after the message end-of-data.
210 Available in Postfix version 2.5 and later:
212 milter_end_of_header_macros (see 'postconf -d' output)
214 The macros that are sent to Milter (mail filter) applications
215 after the end of the message header.
216 Available in Postfix version 2.7 and later:
218 milter_header_checks (empty)
220 Optional lookup tables for content inspection of message headers
221 that are produced by Milter applications.
222 Available in Postfix version 3.1 and later:
224 milter_macro_defaults (empty)
226 Optional list of name=value pairs that specify default values
227 for arbitrary macros that Postfix may send to Milter applica‐
228 tions.
229
231 Available in Postfix version 2.0 and later:
232 disable_mime_input_processing (no)
234 Turn off MIME processing while receiving mail.
235 mime_boundary_length_limit (2048)
237 The maximal length of MIME multipart boundary strings.
238 mime_nesting_limit (100)
240 The maximal recursion level that the MIME processor will handle.
241 strict_8bitmime (no)
243 Enable both strict_7bit_headers and strict_8bitmime_body.
244 strict_7bit_headers (no)
246 Reject mail with 8-bit text in message headers.
247 strict_8bitmime_body (no)
249 Reject 8-bit message body text without 8-bit MIME content encod‐
250 ing information.
251 strict_mime_encoding_domain (no)
253 Reject mail with invalid Content-Transfer-Encoding: information
254 for the message/* or multipart/* MIME content types.
255 Available in Postfix version 2.5 and later:
257 detect_8bit_encoding_header (yes)
259 Automatically detect 8BITMIME body content by looking at Con‐
260 tent-Transfer-Encoding: message headers; historically, this
261 behavior was hard-coded to be "always on".
262
264 Postfix can automatically add BCC (blind carbon copy) when mail enters
265 the mail system:
266 always_bcc (empty)
268 Optional address that receives a "blind carbon copy" of each
269 message that is received by the Postfix mail system.
270 Available in Postfix version 2.1 and later:
272 sender_bcc_maps (empty)
274 Optional BCC (blind carbon-copy) address lookup tables, indexed
275 by sender address.
276 recipient_bcc_maps (empty)
278 Optional BCC (blind carbon-copy) address lookup tables, indexed
279 by recipient address.
280
282 Address rewriting is delegated to the trivial-rewrite(8) daemon. The
283 cleanup(8) server implements table driven address mapping.
284 empty_address_recipient (MAILER-DAEMON)
286 The recipient of mail addressed to the null address.
287 canonical_maps (empty)
289 Optional address mapping lookup tables for message headers and
290 envelopes.
291 recipient_canonical_maps (empty)
293 Optional address mapping lookup tables for envelope and header
294 recipient addresses.
295 sender_canonical_maps (empty)
297 Optional address mapping lookup tables for envelope and header
298 sender addresses.
299 masquerade_classes (envelope_sender, header_sender, header_recipient)
301 What addresses are subject to address masquerading.
302 masquerade_domains (empty)
304 Optional list of domains whose subdomain structure will be
305 stripped off in email addresses.
306 masquerade_exceptions (empty)
308 Optional list of user names that are not subjected to address
309 masquerading, even when their addresses match $masquer‐
310 ade_domains.
311 propagate_unmatched_extensions (canonical, virtual)
313 What address lookup tables copy an address extension from the
314 lookup key to the lookup result.
315 Available before Postfix version 2.0:
317 virtual_maps (empty)
319 Optional lookup tables with a) names of domains for which all
320 addresses are aliased to addresses in other local or remote
321 domains, and b) addresses that are aliased to addresses in other
322 local or remote domains.
323 Available in Postfix version 2.0 and later:
325 virtual_alias_maps ($virtual_maps)
327 Optional lookup tables that alias specific mail addresses or
328 domains to other local or remote address.
329 Available in Postfix version 2.2 and later:
331 canonical_classes (envelope_sender, envelope_recipient, header_sender,
333 header_recipient)
334 What addresses are subject to canonical_maps address mapping.
335 recipient_canonical_classes (envelope_recipient, header_recipient)
337 What addresses are subject to recipient_canonical_maps address
338 mapping.
339 sender_canonical_classes (envelope_sender, header_sender)
341 What addresses are subject to sender_canonical_maps address map‐
342 ping.
343 remote_header_rewrite_domain (empty)
345 Don't rewrite message headers from remote clients at all when
346 this parameter is empty; otherwise, rewrite message headers and
347 append the specified domain name to incomplete addresses.
348
350 duplicate_filter_limit (1000)
351 The maximal number of addresses remembered by the address dupli‐
352 cate filter for aliases(5) or virtual(5) alias expansion, or for
353 showq(8) queue displays.
354 header_size_limit (102400)
356 The maximal amount of memory in bytes for storing a message
357 header.
358 hopcount_limit (50)
360 The maximal number of Received: message headers that is allowed
361 in the primary message headers.
362 in_flow_delay (1s)
364 Time to pause before accepting a new message, when the message
365 arrival rate exceeds the message delivery rate.
366 message_size_limit (10240000)
368 The maximal size in bytes of a message, including envelope
369 information.
370 Available in Postfix version 2.0 and later:
372 header_address_token_limit (10240)
374 The maximal number of address tokens are allowed in an address
375 message header.
376 mime_boundary_length_limit (2048)
378 The maximal length of MIME multipart boundary strings.
379 mime_nesting_limit (100)
381 The maximal recursion level that the MIME processor will handle.
382 queue_file_attribute_count_limit (100)
384 The maximal number of (name=value) attributes that may be stored
385 in a Postfix queue file.
386 Available in Postfix version 2.1 and later:
388 virtual_alias_expansion_limit (1000)
390 The maximal number of addresses that virtual alias expansion
391 produces from each original recipient.
392 virtual_alias_recursion_limit (1000)
394 The maximal nesting depth of virtual alias expansion.
395 Available in Postfix version 3.0 and later:
397 virtual_alias_address_length_limit (1000)
399 The maximal length of an email address after virtual alias
400 expansion.
401
403 Preliminary SMTPUTF8 support is introduced with Postfix 3.0.
404 smtputf8_enable (yes)
406 Enable preliminary SMTPUTF8 support for the protocols described
407 in RFC 6531..6533.
408 smtputf8_autodetect_classes (sendmail, verify)
410 Detect that a message requires SMTPUTF8 support for the speci‐
411 fied mail origin classes.
412 Available in Postfix version 3.2 and later:
414 enable_idna2003_compatibility (no)
416 Enable 'transitional' compatibility between IDNA2003 and
417 IDNA2008, when converting UTF-8 domain names to/from the ASCII
418 form that is used for DNS lookups.
419
421 config_directory (see 'postconf -d' output)
422 The default location of the Postfix main.cf and master.cf con‐
423 figuration files.
424 daemon_timeout (18000s)
426 How much time a Postfix daemon process may take to handle a
427 request before it is terminated by a built-in watchdog timer.
428 delay_logging_resolution_limit (2)
430 The maximal number of digits after the decimal point when log‐
431 ging sub-second delay values.
432 delay_warning_time (0h)
434 The time after which the sender receives a copy of the message
435 headers of mail that is still queued.
436 ipc_timeout (3600s)
438 The time limit for sending or receiving information over an
439 internal communication channel.
440 max_idle (100s)
442 The maximum amount of time that an idle Postfix daemon process
443 waits for an incoming connection before terminating voluntarily.
444 max_use (100)
446 The maximal number of incoming connections that a Postfix daemon
447 process will service before terminating voluntarily.
448 myhostname (see 'postconf -d' output)
450 The internet hostname of this mail system.
451 myorigin ($myhostname)
453 The domain name that locally-posted mail appears to come from,
454 and that locally posted mail is delivered to.
455 process_id (read-only)
457 The process ID of a Postfix command or daemon process.
458 process_name (read-only)
460 The process name of a Postfix command or daemon process.
461 queue_directory (see 'postconf -d' output)
463 The location of the Postfix top-level queue directory.
464 soft_bounce (no)
466 Safety net to keep mail queued that would otherwise be returned
467 to the sender.
468 syslog_facility (mail)
470 The syslog facility of Postfix logging.
471 syslog_name (see 'postconf -d' output)
473 A prefix that is prepended to the process name in syslog
474 records, so that, for example, "smtpd" becomes "prefix/smtpd".
475 Available in Postfix version 2.1 and later:
477 enable_original_recipient (yes)
479 Enable support for the original recipient address after an
480 address is rewritten to a different address (for example with
481 aliasing or with canonical mapping).
482 Available in Postfix 3.3 and later:
484 service_name (read-only)
486 The master.cf service name of a Postfix daemon process.
487 Available in Postfix 3.5 and later:
489 info_log_address_format (external)
491 The email address form that will be used in non-debug logging
492 (info, warning, etc.).
493
495 /etc/postfix/canonical*, canonical mapping table
496 /etc/postfix/virtual*, virtual mapping table
497
499 trivial-rewrite(8), address rewriting
500 qmgr(8), queue manager
501 header_checks(5), message header content inspection
502 body_checks(5), body parts content inspection
503 canonical(5), canonical address lookup table format
504 virtual(5), virtual alias lookup table format
505 postconf(5), configuration parameters
506 master(5), generic daemon options
507 master(8), process manager
508 postlogd(8), Postfix logging
509 syslogd(8), system logging
510
512 Use "postconf readme_directory" or "postconf html_directory" to locate
513 this information.
514 ADDRESS_REWRITING_README Postfix address manipulation
515 CONTENT_INSPECTION_README content inspection
516
518 The Secure Mailer license must be distributed with this software.
519
521 Wietse Venema
522 IBM T.J. Watson Research
523 P.O. Box 704
524 Yorktown Heights, NY 10598, USA
525 Wietse Venema
527 Google, Inc.
528 111 8th Avenue
529 New York, NY 10011, USA
530 CLEANUP(8)