The bounce() command creates a non-delivery message to the sender of the email.
This command creates a bounce email (also called non-delivery notification (NDN) or non-delivery report/receipt (NDR)) and deletes the original email. The appearance of the bounce email is defined by a template. The sender of this bounce email is the Postmaster (see Mail System SMTP settings Postmaster address). Optionally, the header of the original email is attached to the bounce email as a file attachment.
•The email is first accepted by the email system and only discarded when the bounce email is created (see difference to drop()) •All subsequent commands are ignored •This command cannot be the condition for an if/else statement (see section Control Structures - If/Else Statements). |
Structure of the command
bounce('template', ['attach_header']);
Return value
no
Parameters
template
Defines the template to be used.
Templates are defined and managed via the administration interface (see Mail System Edit mail templates...).
attach_header
This parameter specifies whether the header of the original email of the bounce email should be attached as a file attachment (true) or not (false).
Possible values
•true, yes or 1
•false, no or 0
The default setting is 0
Example 1
Line |
Code |
---|---|
01 |
bounce('bounce','yes'); |
Explanation
The delivery of the email is to be prevented. At the same time, the sender is to be informed via a return (bounce) email. The content of this return email is defined in the template bounce. Furthermore, the header of the undelivered email is attached as an attachment (value yesof the parameter attach_header).