module documentation
(source)

Support for bounce message generation.

Variable BOUNCE_FORMAT Undocumented
Function generateBounce Generate a bounce message for an undeliverable email message.
BOUNCE_FORMAT = (source)

Undocumented

(type: str)
def generateBounce(message, failedFrom, failedTo, transcript='', encoding='utf-8'): (source)

Generate a bounce message for an undeliverable email message.

ParametersmessageThe undeliverable message. (type: a file-like object)
failedFromThe originator of the undeliverable message. (type: bytes or unicode)
failedToThe destination of the undeliverable message. (type: bytes or unicode)
transcriptAn error message to include in the bounce message. (type: bytes or unicode)
encodingEncoding to use, default: utf-8 (type: str or unicode)
ReturnsThe originator, the destination and the contents of the bounce message. The destination of the bounce message is the originator of the undeliverable message. (type: 3-tuple of (1) bytes, (2) bytes, (3) bytes)
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.