twisted.mail.alias.AliasBase class documentation

Part of twisted.mail.alias View Source (View In Hierarchy)

Known subclasses: twisted.mail.alias.AddressAlias, twisted.mail.alias.AliasGroup, twisted.mail.alias.FileAlias, twisted.mail.alias.ProcessAlias

The default base class for aliases.

Instance Variable domains See __init__.
Instance Variable original The original address being aliased. (type: Address)
Method __init__
Method domain Return the domain associated with original address.
Method resolve Map this alias to its ultimate destination.
domains =
See __init__.
original =
The original address being aliased. (type: Address)
def __init__(self, domains, original): (source)
overridden in twisted.mail.alias.AddressAlias, twisted.mail.alias.AliasGroup, twisted.mail.alias.FileAlias, twisted.mail.alias.ProcessAlias
ParametersdomainsA mapping of domain name to domain object. (type: dict mapping bytes to IDomain provider)
originalThe original address being aliased. (type: bytes)
def domain(self): (source)

Return the domain associated with original address.

ReturnsThe domain for the original address. (type: IDomain provider)
def resolve(self, aliasmap, memo=None): (source)
overridden in twisted.mail.alias.AddressAlias, twisted.mail.alias.AliasGroup

Map this alias to its ultimate destination.

ParametersaliasmapA mapping of username to alias or group of aliases. (type: dict mapping bytes to AliasBase)
memoA record of the aliases already considered in the resolution process. If provided, memo is modified to include this alias. (type: NoneType or dict of AliasBase)
ReturnsA message receiver for the ultimate destination or None for an invalid destination. (type: IMessage or NoneType)
API Documentation for Twisted, generated by pydoctor at 2016-04-11 10:39:53.