206 lines
9.9 KiB
HTML
206 lines
9.9 KiB
HTML
<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN"
|
|
"https://www.w3.org/TR/html4/loose.dtd">
|
|
<html> <head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<link rel='stylesheet' type='text/css' href='postfix-doc.css'>
|
|
<title> Postfix manual - bounce(5) </title>
|
|
</head> <body> <pre>
|
|
BOUNCE(5) BOUNCE(5)
|
|
|
|
<b><a name="name">NAME</a></b>
|
|
bounce - Postfix bounce message template format
|
|
|
|
<b><a name="synopsis">SYNOPSIS</a></b>
|
|
<b><a href="postconf.5.html#bounce_template_file">bounce_template_file</a> = /etc/postfix/bounce.cf</b>
|
|
|
|
<b>postconf -b</b> [<i>template</i><b>_</b><i>file</i>]
|
|
|
|
<b><a name="description">DESCRIPTION</a></b>
|
|
The Postfix <a href="bounce.8.html"><b>bounce</b>(8)</a> server produces delivery status notification
|
|
(DSN) messages for undeliverable mail, delayed mail, successful deliv-
|
|
ery 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 <b><a href="postconf.5.html#bounce_template_file">bounce_tem</a>-</b>
|
|
<b><a href="postconf.5.html#bounce_template_file">plate_file</a></b> configuration parameter.
|
|
|
|
This document describes the general procedure to create a bounce tem-
|
|
plate file, followed by the specific details of bounce template for-
|
|
mats.
|
|
|
|
<b><a name="general_procedure">GENERAL PROCEDURE</a></b>
|
|
To create a customized bounce template file, create a temporary copy of
|
|
the file <b>/etc/postfix/bounce.cf.default</b> and edit the temporary file.
|
|
|
|
To preview the results of $<i>name</i> expansions in the template text, use
|
|
the command
|
|
|
|
<b>postconf -b</b> <i>temporary</i><b>_</b><i>file</i>
|
|
|
|
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 con-
|
|
figuration directory and specify in <a href="postconf.5.html">main.cf</a> something like:
|
|
|
|
/etc/postfix/<a href="postconf.5.html">main.cf</a>:
|
|
<a href="postconf.5.html#bounce_template_file">bounce_template_file</a> = /etc/postfix/bounce.cf
|
|
|
|
<b><a name="template_file_format">TEMPLATE FILE FORMAT</a></b>
|
|
The template file can specify templates for failed mail, delayed mail,
|
|
successful delivery or for address verification. These templates are
|
|
named <b>failure_template</b>, <b>delay_template</b>, <b>success_template</b> and <b>ver-</b>
|
|
<b>ify_template</b>, respectively. You can but do not have to specify all
|
|
four templates in a bounce template file.
|
|
|
|
Each template starts with "<i>template</i><b>_</b><i>name</i> <b>=</b> <<<b>EOF</b>" and ends with a line
|
|
that contains the word "<b>EOF</b>" only. You can change the word EOF, but you
|
|
can't enclose it in quotes as with the shell or with Perl (<i>tem-</i>
|
|
<i>plate</i><b>_</b><i>name</i> <b>=</b> <<<b>'EOF'</b>). 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 $<a href="postconf.5.html#myhostname">myhostname</a>.
|
|
|
|
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 fol-
|
|
lowing restrictions:
|
|
|
|
<b>o</b> No special meaning is given to the backslash character or to
|
|
leading whitespace; these are always taken literally.
|
|
|
|
<b>o</b> Inside the << context, the "$" character is special. To produce
|
|
a "$" character as output, specify "$$".
|
|
|
|
<b>o</b> 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 <b>bounce.cf.default</b> in
|
|
the Postfix configuration directory.
|
|
|
|
<b><a name="template_header_format">TEMPLATE HEADER FORMAT</a></b>
|
|
The first portion of a bounce template consists of optional template
|
|
headers. Some become message headers in the delivery status notifica-
|
|
tion; 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:
|
|
|
|
<b>Charset:</b>
|
|
The MIME character set of the template message text. See the
|
|
"TEMPLATE MESSAGE TEXT FORMAT" description below.
|
|
|
|
<b>From:</b> The sender address in the message header of the delivery status
|
|
notification.
|
|
|
|
<b>Subject:</b>
|
|
The subject in the message header of the delivery status notifi-
|
|
cation that is returned to the sender.
|
|
|
|
<b>Postmaster-Subject:</b>
|
|
The subject that will be used in Postmaster copies of undeliver-
|
|
able or delayed mail notifications. These copies are sent under
|
|
control of the <a href="postconf.5.html#notify_classes">notify_classes</a> configuration parameter.
|
|
|
|
The usage and specification of template message headers is subject to
|
|
the following restrictions:
|
|
|
|
<b>o</b> 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 "<b>From:</b>" and "<b>Subject:</b>".
|
|
|
|
<b>o</b> Template message headers must not span multiple lines.
|
|
|
|
<b>o</b> Template message headers do not support $parameter expansions.
|
|
|
|
<b>o</b> Template message headers must contain ASCII characters only, and
|
|
must not contain ASCII null characters.
|
|
|
|
<b><a name="template_message_text_format">TEMPLATE MESSAGE TEXT FORMAT</a></b>
|
|
The second portion of a bounce template consists of message text. As
|
|
the above example shows, template message text may contain <a href="postconf.5.html">main.cf</a>
|
|
$parameters. Besides the parameters that are defined in <a href="postconf.5.html">main.cf</a>, the
|
|
following parameters are treated specially depending on the suffix that
|
|
is appended to their name.
|
|
|
|
<b>delay_warning_time_</b><i>suffix</i>
|
|
Expands into the value of the <b><a href="postconf.5.html#delay_warning_time">delay_warning_time</a></b> parameter,
|
|
expressed in the time unit specified by <i>suffix</i>, which is one of
|
|
<b>seconds</b>, <b>minutes</b>, <b>hours, days</b>, or <b>weeks</b>.
|
|
|
|
<b>maximal_queue_lifetime_</b><i>suffix</i>
|
|
Expands into the value of the <b><a href="postconf.5.html#maximal_queue_lifetime">maximal_queue_lifetime</a></b> parameter,
|
|
expressed in the time unit specified by <i>suffix</i>. See above under
|
|
<b><a href="postconf.5.html#delay_warning_time">delay_warning_time</a></b> for possible <i>suffix</i> values.
|
|
|
|
<b><a href="postconf.5.html#mydomain">mydomain</a></b>
|
|
Expands into the value of the <b><a href="postconf.5.html#mydomain">mydomain</a></b> parameter. With "smt-
|
|
putf8_enable = yes", this replaces ACE labels (xn--mumble) with
|
|
their UTF-8 equivalent.
|
|
|
|
This feature is available in Postfix 3.0.
|
|
|
|
<b><a href="postconf.5.html#myhostname">myhostname</a></b>
|
|
Expands into the value of the <b><a href="postconf.5.html#myhostname">myhostname</a></b> parameter. With "smt-
|
|
putf8_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:
|
|
|
|
<b>o</b> The template message text is not sent in Postmaster copies of
|
|
delivery status notifications.
|
|
|
|
<b>o</b> If the template message text contains non-ASCII characters,
|
|
Postfix requires that the <b>Charset:</b> template header is updated.
|
|
Specify an appropriate superset of US-ASCII. A superset is
|
|
needed because Postfix appends ASCII text after the message tem-
|
|
plate when it sends a delivery status notification.
|
|
|
|
<b><a name="see_also">SEE ALSO</a></b>
|
|
<a href="bounce.8.html">bounce(8)</a>, Postfix delivery status notifications
|
|
<a href="postconf.5.html">postconf(5)</a>, configuration parameters
|
|
|
|
<b><a name="license">LICENSE</a></b>
|
|
The Secure Mailer license must be distributed with this software.
|
|
|
|
<b><a name="history">HISTORY</a></b>
|
|
The Postfix bounce template format was originally developed by Nicolas
|
|
Riendeau.
|
|
|
|
<b>AUTHOR(S)</b>
|
|
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
|
|
|
|
BOUNCE(5)
|
|
</pre> </body> </html>
|