twisted.mail.alias.FileAlias : API documentation

class documentation

class FileAlias(AliasBase): (source)

An alias which translates an address to a file.

Instance Variable	`filename`	See `__init__`.
Method	`__init__`
Method	`__str__`	Build a string representation of this `FileAlias` instance.
Method	`createMessageReceiver`	Create a message receiver which delivers a message to the file.

Inherited from AliasBase:

Instance Variable	`domains`	See `__init__`.
Instance Variable	`original`	The original address being aliased.
Method	`domain`	Return the domain associated with original address.
Method	`resolve`	Map this alias to its ultimate destination.

filename = (source)

See __init__.

def __init__(self, filename, *args): (source)

overrides twisted.mail.alias.AliasBase.__init__

Parameters	filename	The name of the file in which to store the message. (type: `bytes`)
	args	Arguments for `AliasBase.__init__`. (type: 2-`tuple` of (0) `dict` mapping `bytes` to `IDomain` provider, (1) `bytes`)

def __str__(self): (source)

Build a string representation of this FileAlias instance.

Returns A string containing the name of the file. (type: bytes)

def createMessageReceiver(self): (source)

from twisted.mail.interfaces.IAlias

Create a message receiver which delivers a message to the file.

Returns A message receiver which writes a message to the file. (type: FileWrapper)

API Documentation for Twisted, generated by pydoctor 21.2.2 at 2021-06-04 02:13:44.