cleanup.8.html   [plain text]


<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN"
        "http://www.w3.org/TR/html4/loose.dtd">
<html> <head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<title> Postfix manual - cleanup(8) </title>
</head> <body> <pre>
CLEANUP(8)                                             CLEANUP(8)

<b>NAME</b>
       cleanup - canonicalize and enqueue Postfix message

<b>SYNOPSIS</b>
       <b>cleanup</b> [generic Postfix daemon options]

<b>DESCRIPTION</b>
       The <b>cleanup</b> daemon processes inbound mail, inserts it into
       the <b>incoming</b> mail queue, and informs the queue manager  of
       its arrival.

       The <b>cleanup</b> daemon always performs the following transfor-
       mations:

       <b>o</b>      Insert missing message  headers:  (<b>Resent-</b>)  <b>From:</b>,
              <b>To:</b>, <b>Message-Id:</b>, and <b>Date:</b>.

       <b>o</b>      Transform  envelope  and  header  addresses  to the
              standard <i>user@fully-qualified-domain</i> form  that  is
              expected  by  other Postfix programs.  This task is
              delegated to the <a href="trivial-rewrite.8.html"><b>trivial-rewrite</b>(8)</a> daemon.

       <b>o</b>      Eliminate duplicate envelope recipient addresses.

       The following address transformations are optional:

       <b>o</b>      Optionally,  rewrite  all   envelope   and   header
              addresses  according  to  the mappings specified in
              the <a href="canonical.5.html"><b>canonical</b>(5)</a> lookup tables.

       <b>o</b>      Optionally, masquerade  envelope  sender  addresses
              and  message  header  addresses (i.e. strip host or
              domain information below all domains listed in  the
              <b><a href="postconf.5.html#masquerade_domains">masquerade_domains</a></b> parameter, except for user names
              listed  in  <b><a href="postconf.5.html#masquerade_exceptions">masquerade_exceptions</a></b>).   By   default,
              address   masquerading  does  not  affect  envelope
              recipients.

       <b>o</b>      Optionally, expand envelope recipients according to
              information  found in the <a href="virtual.5.html"><b>virtual</b>(5)</a> lookup tables.

       The <b>cleanup</b> daemon performs sanity checks on  the  content
       of  each  message.  When it finds a problem, by default it
       returns a diagnostic status to the client, and  leaves  it
       up  to the client to deal with the problem. Alternatively,
       the client can request the <b>cleanup</b> daemon  to  bounce  the
       message back to the sender in case of trouble.

<b>STANDARDS</b>
       <a href="http://www.faqs.org/rfcs/rfc822.html">RFC 822</a> (ARPA Internet Text Messages)
       <a href="http://www.faqs.org/rfcs/rfc2045.html">RFC 2045</a> (MIME: Format of Internet Message Bodies)
       <a href="http://www.faqs.org/rfcs/rfc2046.html">RFC 2046</a> (MIME: Media Types)

<b>DIAGNOSTICS</b>
       Problems and transactions are logged to <b>syslogd</b>(8).

<b>BUGS</b>
       Table-driven  rewriting  rules  make it hard to express <b>if</b>
       <b>then else</b> and other logical relationships.

<b>CONFIGURATION PARAMETERS</b>
       Changes  to  <b>main.cf</b>  are  picked  up  automatically,   as
       <a href="cleanup.8.html">cleanup(8)</a>  processes  run  for  only  a limited amount of
       time. Use the command  "<b>postfix  reload</b>"  to  speed  up  a
       change.

       The  text  below  provides  only  a parameter summary. See
       <a href="postconf.5.html">postconf(5)</a> for more details including examples.

<b>COMPATIBILITY CONTROLS</b>
       <b><a href="postconf.5.html#undisclosed_recipients_header">undisclosed_recipients_header</a>   (To:   undisclosed-recipi-</b>
       <b>ents:;)</b>
              Message header that the Postfix  <a href="cleanup.8.html">cleanup(8)</a>  server
              inserts  when a message contains no To: or Cc: mes-
              sage header.

       Available in Postfix version 2.1 and later:

       <b>enable_errors_to (no)</b>
              Report mail delivery errors to the  address  speci-
              fied   with  the  non-standard  Errors-To:  message
              header, instead of the envelope sender address.

<b>BUILT-IN CONTENT FILTERING CONTROLS</b>
       Postfix built-in content filtering  is  meant  to  stop  a
       flood  of  worms  or  viruses. It is not a general content
       filter.

       <b><a href="postconf.5.html#body_checks">body_checks</a> (empty)</b>
              Optional lookup tables for  content  inspection  as
              specified in the <a href="header_checks.5.html">body_checks(5)</a> manual page.

       <b><a href="postconf.5.html#header_checks">header_checks</a> (empty)</b>
              Optional  lookup  tables  for content inspection of
              primary non-MIME message headers, as  specified  in
              the <a href="header_checks.5.html">header_checks(5)</a> manual page.

       Available in Postfix version 2.0 and later:

       <b><a href="postconf.5.html#body_checks_size_limit">body_checks_size_limit</a> (51200)</b>
              How much text in a message body segment (or attach-
              ment, if you prefer to use that term) is  subjected
              to <a href="postconf.5.html#body_checks">body_checks</a> inspection.

       <b><a href="postconf.5.html#mime_header_checks">mime_header_checks</a> ($<a href="postconf.5.html#header_checks">header_checks</a>)</b>
              Optional  lookup  tables  for content inspection of
              MIME related message headers, as described  in  the
              <a href="header_checks.5.html">header_checks(5)</a> manual page.

       <b><a href="postconf.5.html#nested_header_checks">nested_header_checks</a> ($<a href="postconf.5.html#header_checks">header_checks</a>)</b>
              Optional  lookup  tables  for content inspection of
              non-MIME message headers in attached  messages,  as
              described in the <a href="header_checks.5.html">header_checks(5)</a> manual page.

<b>MIME PROCESSING CONTROLS</b>
       Available in Postfix version 2.0 and later:

       <b><a href="postconf.5.html#disable_mime_input_processing">disable_mime_input_processing</a> (no)</b>
              Turn off MIME processing while receiving mail.

       <b><a href="postconf.5.html#mime_boundary_length_limit">mime_boundary_length_limit</a> (2048)</b>
              The  maximal  length  of  MIME  multipart  boundary
              strings.

       <b><a href="postconf.5.html#mime_nesting_limit">mime_nesting_limit</a> (100)</b>
              The maximal nesting level of  multipart  mail  that
              the MIME processor will handle.

       <b><a href="postconf.5.html#strict_8bitmime">strict_8bitmime</a> (no)</b>
              Enable  both  <a href="postconf.5.html#strict_7bit_headers">strict_7bit_headers</a>  and strict_8bit-
              mime_body.

       <b><a href="postconf.5.html#strict_7bit_headers">strict_7bit_headers</a> (no)</b>
              Reject mail with 8-bit text in message headers.

       <b><a href="postconf.5.html#strict_8bitmime_body">strict_8bitmime_body</a> (no)</b>
              Reject 8-bit message body text without  8-bit  MIME
              content encoding information.

       <b><a href="postconf.5.html#strict_mime_encoding_domain">strict_mime_encoding_domain</a> (no)</b>
              Reject mail with invalid Content-Transfer-Encoding:
              information for the message/* or  multipart/*  MIME
              content types.

<b>AUTOMATIC BCC RECIPIENT CONTROLS</b>
       Postfix can automatically add BCC (blind carbon copy) when
       mail enters the mail system:

       <b><a href="postconf.5.html#always_bcc">always_bcc</a> (empty)</b>
              Optional address  that  receives  a  "blind  carbon
              copy" of each message that is received by the Post-
              fix mail system.

       Available in Postfix version 2.1 and later:

       <b><a href="postconf.5.html#sender_bcc_maps">sender_bcc_maps</a> (empty)</b>
              Optional BCC  (blind  carbon-copy)  address  lookup
              tables, indexed by sender address.

       <b><a href="postconf.5.html#recipient_bcc_maps">recipient_bcc_maps</a> (empty)</b>
              Optional  BCC  (blind  carbon-copy)  address lookup
              tables, indexed by recipient address.

<b>ADDRESS TRANSFORMATION CONTROLS</b>
       Address rewriting is delegated to  the  <a href="trivial-rewrite.8.html">trivial-rewrite(8)</a>
       daemon.   The  <a href="cleanup.8.html">cleanup(8)</a>  server  implements table driven
       address mapping.

       <b><a href="postconf.5.html#empty_address_recipient">empty_address_recipient</a> (MAILER-DAEMON)</b>
              The  recipient  of  mail  addressed  to  the   null
              address.

       <b><a href="postconf.5.html#canonical_maps">canonical_maps</a> (empty)</b>
              Optional  address mapping lookup tables for message
              headers and envelopes.

       <b><a href="postconf.5.html#recipient_canonical_maps">recipient_canonical_maps</a> (empty)</b>
              Optional address mapping lookup tables for envelope
              and header recipient addresses.

       <b><a href="postconf.5.html#sender_canonical_maps">sender_canonical_maps</a> (empty)</b>
              Optional address mapping lookup tables for envelope
              and header sender addresses.

       <b><a href="postconf.5.html#masquerade_classes">masquerade_classes</a>    (envelope_sender,     header_sender,</b>
       <b>header_recipient)</b>
              What addresses are subject to address masquerading.

       <b><a href="postconf.5.html#masquerade_domains">masquerade_domains</a> (empty)</b>
              Optional  list of domains whose subdomain structure
              will be stripped off in email addresses.

       <b><a href="postconf.5.html#masquerade_exceptions">masquerade_exceptions</a> (empty)</b>
              Optional list of user names that are not  subjected
              to  address  masquerading,  even when their address
              matches $<a href="postconf.5.html#masquerade_domains">masquerade_domains</a>.

       <b><a href="postconf.5.html#propagate_unmatched_extensions">propagate_unmatched_extensions</a> (canonical, virtual)</b>
              What address lookup tables copy an  address  exten-
              sion from the lookup key to the lookup result.

       Available before Postfix version 2.0:

       <b><a href="postconf.5.html#virtual_maps">virtual_maps</a> (empty)</b>
              Optional lookup tables with a) names of domains for
              which all addresses are  aliased  to  addresses  in
              other  local  or  remote  domains, and b) addresses
              that are aliased to addresses  in  other  local  or
              remote domains.

       Available in Postfix version 2.0 and later:

       <b><a href="postconf.5.html#virtual_alias_maps">virtual_alias_maps</a> ($<a href="postconf.5.html#virtual_maps">virtual_maps</a>)</b>
              Optional  lookup  tables  that  alias specific mail
              addresses or  domains  to  other  local  or  remote
              address.

<b>RESOURCE AND RATE CONTROLS</b>
       <b><a href="postconf.5.html#duplicate_filter_limit">duplicate_filter_limit</a> (1000)</b>
              The  maximal  number of addresses remembered by the
              address duplicate filter  for  <a href="aliases.5.html">aliases(5)</a>  or  vir-
              tual(5) alias expansion, or for <a href="showq.8.html">showq(8)</a> queue dis-
              plays.

       <b><a href="postconf.5.html#header_size_limit">header_size_limit</a> (102400)</b>
              The maximal amount of memory in bytes for storing a
              message header.

       <b><a href="postconf.5.html#hopcount_limit">hopcount_limit</a> (50)</b>
              The  maximal  number  of Received:  message headers
              that is allowed in the primary message headers.

       <b><a href="postconf.5.html#in_flow_delay">in_flow_delay</a> (1s)</b>
              Time to pause before accepting a new message,  when
              the message arrival rate exceeds the message deliv-
              ery rate.

       <b><a href="postconf.5.html#message_size_limit">message_size_limit</a> (10240000)</b>
              The maximal size in bytes of a  message,  including
              envelope information.

       Available in Postfix version 2.0 and later:

       <b><a href="postconf.5.html#header_address_token_limit">header_address_token_limit</a> (10240)</b>
              The maximal number of address tokens are allowed in
              an address message header.

       <b><a href="postconf.5.html#mime_boundary_length_limit">mime_boundary_length_limit</a> (2048)</b>
              The  maximal  length  of  MIME  multipart  boundary
              strings.

       <b><a href="postconf.5.html#mime_nesting_limit">mime_nesting_limit</a> (100)</b>
              The  maximal  nesting  level of multipart mail that
              the MIME processor will handle.

       <b><a href="postconf.5.html#queue_file_attribute_count_limit">queue_file_attribute_count_limit</a> (100)</b>
              The maximal number of (name=value) attributes  that
              may be stored in a Postfix queue file.

       Available in Postfix version 2.1 and later:

       <b><a href="postconf.5.html#virtual_alias_expansion_limit">virtual_alias_expansion_limit</a> (1000)</b>
              The  maximal number of addresses that virtual alias
              expansion produces from each original recipient.

       <b><a href="postconf.5.html#virtual_alias_recursion_limit">virtual_alias_recursion_limit</a> (1000)</b>
              The maximal nesting depth of virtual  alias  expan-
              sion.

<b>MISCELLANEOUS CONTROLS</b>
       <b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b>
              The  default  location  of  the Postfix main.cf and
              master.cf configuration files.

       <b><a href="postconf.5.html#daemon_timeout">daemon_timeout</a> (18000s)</b>
              How much time a Postfix daemon process may take  to
              handle  a  request  before  it  is  terminated by a
              built-in watchdog timer.

       <b><a href="postconf.5.html#delay_warning_time">delay_warning_time</a> (0h)</b>
              The time after which the sender receives  the  mes-
              sage headers of mail that is still queued.

       <b><a href="postconf.5.html#ipc_timeout">ipc_timeout</a> (3600s)</b>
              The time limit for sending or receiving information
              over an internal communication channel.

       <b><a href="postconf.5.html#max_idle">max_idle</a> (100s)</b>
              The maximum amount of time  that  an  idle  Postfix
              daemon  process  waits for the next service request
              before exiting.

       <b><a href="postconf.5.html#max_use">max_use</a> (100)</b>
              The maximal number of connection requests before  a
              Postfix daemon process terminates.

       <b><a href="postconf.5.html#myhostname">myhostname</a> (see 'postconf -d' output)</b>
              The internet hostname of this mail system.

       <b><a href="postconf.5.html#myorigin">myorigin</a> ($<a href="postconf.5.html#myhostname">myhostname</a>)</b>
              The  default  domain  name that locally-posted mail
              appears to come from, and that locally posted  mail
              is delivered to.

       <b><a href="postconf.5.html#process_id">process_id</a> (read-only)</b>
              The  process ID of a Postfix command or daemon pro-
              cess.

       <b><a href="postconf.5.html#process_name">process_name</a> (read-only)</b>
              The process name of a  Postfix  command  or  daemon
              process.

       <b><a href="postconf.5.html#queue_directory">queue_directory</a> (see 'postconf -d' output)</b>
              The  location of the Postfix top-level queue direc-
              tory.

       <b><a href="postconf.5.html#soft_bounce">soft_bounce</a> (no)</b>
              Safety net to keep mail queued that would otherwise
              be returned to the sender.

       <b><a href="postconf.5.html#syslog_facility">syslog_facility</a> (mail)</b>
              The syslog facility of Postfix logging.

       <b><a href="postconf.5.html#syslog_name">syslog_name</a> (postfix)</b>
              The  mail system name that is prepended to the pro-
              cess  name  in  syslog  records,  so  that  "smtpd"
              becomes, for example, "postfix/smtpd".

       Available in Postfix version 2.1 and later:

       <b><a href="postconf.5.html#enable_original_recipient">enable_original_recipient</a> (yes)</b>
              Enable   support   for  the  X-Original-To  message
              header.

<b>FILES</b>
       /etc/postfix/canonical*, canonical mapping table
       /etc/postfix/virtual*, virtual mapping table

<b>SEE ALSO</b>
       <a href="trivial-rewrite.8.html">trivial-rewrite(8)</a>, address rewriting
       <a href="qmgr.8.html">qmgr(8)</a>, queue manager
       <a href="header_checks.5.html">header_checks(5)</a>, message header content inspection
       <a href="header_checks.5.html">body_checks(5)</a>, body parts content inspection
       <a href="canonical.5.html">canonical(5)</a>, canonical address lookup table format
       <a href="virtual.5.html">virtual(5)</a>, virtual alias lookup table format
       <a href="postconf.5.html">postconf(5)</a>, configuration parameters
       <a href="master.8.html">master(8)</a>, process manager
       syslogd(8), system logging

<b>README FILES</b>
       <a href="ADDRESS_REWRITING_README.html">ADDRESS_REWRITING_README</a> Postfix address manipulation

<b>LICENSE</b>
       The  Secure  Mailer  license must be distributed with this
       software.

<b>AUTHOR(S)</b>
       Wietse Venema
       IBM T.J. Watson Research
       P.O. Box 704
       Yorktown Heights, NY 10598, USA

                                                       CLEANUP(8)
</pre> </body> </html>