BOUNCE
Section: File Formats (5)Index Return to Main Contents
NAME
bounce - Postfix bounce message template formatSYNOPSIS
bounce_template_file = /etc/postfix/bounce.cf postconf -b [template_file]
DESCRIPTION
The Postfix bounce(8) server produces delivery status notification (DSN) messages for undeliverable mail, delayed mail, successful delivery or address verification requests.By default, these notifications are generated from built-in templates with message headers and message text. Sites can override the built-in information by specifying a bounce template file with the bounce_template_file configuration parameter.
This document describes the general procedure to create a bounce template file, followed by the specific details of bounce template formats.
GENERAL PROCEDURE
To create a customized bounce template file, create a temporary copy of the file /etc/postfix/bounce.cf.default and edit the temporary file.
To preview the results of $name expansions in the template text, use the command
postconf -b temporary_file
Errors in the template will be reported to the standard error stream and to the syslog daemon.
While previewing the text, be sure to pay particular attention to the expansion of time value parameters that appear in the delayed mail notification text.
Once the result is satisfactory, copy the template to the Postfix configuration directory and specify in main.cf something like:
/etc/postfix/main.cf: bounce_template_file = /etc/postfix/bounce.cf
TEMPLATE FILE FORMAT
The template file can specify templates for failed mail, delayed mail, successful delivery or for address verification. These templates are named failure_template, delay_template, success_template and verify_template, respectively. You can but do not have to specify all four templates in a bounce template file.
Each template starts with "template_name = <<EOF" and ends with a line that contains the word "EOF" only. You can change the word EOF, but you can't enclose it in quotes as with the shell or with Perl (template_name = <<'EOF'). Here is an example:
# The failure template is used for undeliverable mail. failure_template = <<EOF Charset: us-ascii From: MAILER-DAEMON (Mail Delivery System) Subject: Undelivered Mail Returned to Sender Postmaster-Subject: Postmaster Copy: Undelivered Mail This is the mail system at host $myhostname. I'm sorry to have to inform you that your message could not be delivered to one or more recipients. It's attached below. For further assistance, please send mail to postmaster. If you do so, please include this problem report. You can delete your own text from the attached returned message. The mail system EOF
The usage and specification of bounce templates is subject to the following restrictions:
- •
- No special meaning is given to the backslash character or to leading whitespace; these are always taken literally.
- •
- Inside the << context, the "$" character is special. To produce a "$" character as output, specify "$$".
- •
- Outside the << context, lines beginning with "#" are ignored, as are empty lines, and lines consisting of whitespace only.
Examples of all templates can be found in the file bounce.cf.default in the Postfix configuration directory.
TEMPLATE HEADER FORMAT
The first portion of a bounce template consists of optional template headers. Some become message headers in the delivery status notification; some control the formatting of that notification. Headers not specified in a template will be left at their default value.
The following headers are supported:
- Charset:
- The MIME character set of the template message text. See the "TEMPLATE MESSAGE TEXT FORMAT" description below.
- From:
- The sender address in the message header of the delivery status notification.
- Subject:
- The subject in the message header of the delivery status notification that is returned to the sender.
- Postmaster-Subject:
- The subject that will be used in Postmaster copies of undeliverable or delayed mail notifications. These copies are sent under control of the notify_classes configuration parameter.
The usage and specification of template message headers is subject to the following restrictions:
- •
- Template message header names can be specified in upper case, lower case or mixed case. Postfix always produces bounce message header labels of the form "From:" and "Subject:".
- •
- Template message headers must not span multiple lines.
- •
- Template message headers do not support $parameter expansions.
- •
- Template message headers must contain ASCII characters only, and must not contain ASCII null characters.
TEMPLATE MESSAGE TEXT FORMAT
The second portion of a bounce template consists of message text. As the above example shows, template message text may contain main.cf $parameters. Besides the parameters that are defined in main.cf, the following parameters are treated specially depending on the suffix that is appended to their name.
- delay_warning_time_suffix
- Expands into the value of the delay_warning_time parameter, expressed in the time unit specified by suffix, which is one of seconds, minutes, hours, days, or weeks.
- maximal_queue_lifetime_suffix
- Expands into the value of the maximal_queue_lifetime parameter, expressed in the time unit specified by suffix. See above under delay_warning_time for possible suffix values.
- mydomain
-
Expands into the value of the mydomain parameter.
With "smtputf8_enable = yes", this replaces ACE labels
(xn--mumble) with their UTF-8 equivalent.
This feature is available in Postfix 3.0.
- myhostname
-
Expands into the value of the myhostname parameter.
With "smtputf8_enable = yes", this replaces ACE labels
(xn--mumble) with their UTF-8 equivalent.
This feature is available in Postfix 3.0.
The usage and specification of template message text is subject to the following restrictions:
- •
- The template message text is not sent in Postmaster copies of delivery status notifications.
- •
- If the template message text contains non-ASCII characters, Postfix requires that the Charset: template header is updated. Specify an appropriate superset of US-ASCII. A superset is needed because Postfix appends ASCII text after the message template when it sends a delivery status notification.
SEE ALSO
bounce(8), Postfix delivery status notifications postconf(5), configuration parameters
LICENSE
The Secure Mailer license must be distributed with this software.
HISTORY
The Postfix bounce template format was originally developed by Nicolas Riendeau.AUTHOR(S)
Wietse Venema IBM T.J. Watson Research P.O. Box 704 Yorktown Heights, NY 10598, USA Wietse Venema Google, Inc. 111 8th Avenue New York, NY 10011, USA
Index
- NAME
- SYNOPSIS
- DESCRIPTION
- GENERAL PROCEDURE
- TEMPLATE FILE FORMAT
- TEMPLATE HEADER FORMAT
- TEMPLATE MESSAGE TEXT FORMAT
- SEE ALSO
- LICENSE
- HISTORY
- AUTHOR(S)
This document was created by man2html, using the manual pages.
Time: 04:45:53 GMT, September 16, 2022 Content-type: text/html; charset=UTF-8
BOUNCE
Section: Misc. Reference Manual Pages (8postfix)Index Return to Main Contents
NAME
bounce - Postfix delivery status reportsSYNOPSIS
bounce [generic Postfix daemon options]
DESCRIPTION
The bounce(8) daemon maintains per-message log files with delivery status information. Each log file is named after the queue file that it corresponds to, and is kept in a queue subdirectory named after the service name in the master.cf file (either bounce, defer or trace). This program expects to be run from the master(8) process manager.The bounce(8) daemon processes two types of service requests:
- •
- Append a recipient (non-)delivery status record to a per-message log file.
- •
- Enqueue a delivery status notification message, with a copy of a per-message log file and of the corresponding message. When the delivery status notification message is enqueued successfully, the per-message log file is deleted.
The software does a best notification effort. A non-delivery notification is sent even when the log file or the original message cannot be read.
Optionally, a bounce (defer, trace) client can request that the per-message log file be deleted when the requested operation fails. This is used by clients that cannot retry transactions by themselves, and that depend on retry logic in their own client.
STANDARDS
RFC 822 (ARPA Internet Text Messages) RFC 2045 (Format of Internet Message Bodies) RFC 2822 (Internet Message Format) RFC 3462 (Delivery Status Notifications) RFC 3464 (Delivery Status Notifications) RFC 3834 (Auto-Submitted: message header) RFC 5322 (Internet Message Format) RFC 6531 (Internationalized SMTP) RFC 6532 (Internationalized Message Format) RFC 6533 (Internationalized Delivery Status Notifications)
DIAGNOSTICS
Problems and transactions are logged to syslogd(8).CONFIGURATION PARAMETERS
Changes to main.cf are picked up automatically, as bounce(8) processes run for only a limited amount of time. Use the command "postfix reload" to speed up a change.
The text below provides only a parameter summary. See postconf(5) for more details including examples.
- 2bounce_notice_recipient (postmaster)
- The recipient of undeliverable mail that cannot be returned to the sender.
- backwards_bounce_logfile_compatibility (yes)
- Produce additional bounce(8) logfile records that can be read by Postfix versions before 2.0.
- bounce_notice_recipient (postmaster)
- The recipient of postmaster notifications with the message headers of mail that Postfix did not deliver and of SMTP conversation transcripts of mail that Postfix did not receive.
- bounce_size_limit (50000)
- The maximal amount of original message text that is sent in a non-delivery notification.
- bounce_template_file (empty)
- Pathname of a configuration file with bounce message templates.
- config_directory (see 'postconf -d' output)
- The default location of the Postfix main.cf and master.cf configuration files.
- daemon_timeout (18000s)
- How much time a Postfix daemon process may take to handle a request before it is terminated by a built-in watchdog timer.
- delay_notice_recipient (postmaster)
- The recipient of postmaster notifications with the message headers of mail that cannot be delivered within $delay_warning_time time units.
- deliver_lock_attempts (20)
- The maximal number of attempts to acquire an exclusive lock on a mailbox file or bounce(8) logfile.
- deliver_lock_delay (1s)
- The time between attempts to acquire an exclusive lock on a mailbox file or bounce(8) logfile.
- ipc_timeout (3600s)
- The time limit for sending or receiving information over an internal communication channel.
- internal_mail_filter_classes (empty)
- What categories of Postfix-generated mail are subject to before-queue content inspection by non_smtpd_milters, header_checks and body_checks.
- mail_name (Postfix)
- The mail system name that is displayed in Received: headers, in the SMTP greeting banner, and in bounced mail.
- max_idle (100s)
- The maximum amount of time that an idle Postfix daemon process waits for an incoming connection before terminating voluntarily.
- max_use (100)
- The maximal number of incoming connections that a Postfix daemon process will service before terminating voluntarily.
- notify_classes (resource, software)
- The list of error classes that are reported to the postmaster.
- process_id (read-only)
- The process ID of a Postfix command or daemon process.
- process_name (read-only)
- The process name of a Postfix command or daemon process.
- queue_directory (see 'postconf -d' output)
- The location of the Postfix top-level queue directory.
- syslog_facility (mail)
- The syslog facility of Postfix logging.
- syslog_name (see 'postconf -d' output)
- A prefix that is prepended to the process name in syslog records, so that, for example, "smtpd" becomes "prefix/smtpd".
Available in Postfix 3.0 and later:
- smtputf8_autodetect_classes (sendmail, verify)
- Detect that a message requires SMTPUTF8 support for the specified mail origin classes.
Available in Postfix 3.3 and later:
- service_name (read-only)
- The master.cf service name of a Postfix daemon process.
FILES
/var/spool/postfix/bounce/* non-delivery records /var/spool/postfix/defer/* non-delivery records /var/spool/postfix/trace/* delivery status records
SEE ALSO
bounce(5), bounce message template format qmgr(8), queue manager postconf(5), configuration parameters master(5), generic daemon options master(8), process manager syslogd(8), system logging
LICENSE
The Secure Mailer license must be distributed with this software.
AUTHOR(S)
Wietse Venema IBM T.J. Watson Research P.O. Box 704 Yorktown Heights, NY 10598, USA Wietse Venema Google, Inc. 111 8th Avenue New York, NY 10011, USA
Index
- NAME
- SYNOPSIS
- DESCRIPTION
- STANDARDS
- DIAGNOSTICS
- CONFIGURATION PARAMETERS
- FILES
- SEE ALSO
- LICENSE
- AUTHOR(S)
This document was created by man2html, using the manual pages.
Time: 04:46:01 GMT, September 16, 2022
0 댓글