twisted.mail.alias.AliasBase

class documentation

class AliasBase: (source)

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

Constructor: AliasBase(domains, original)

View In Hierarchy

The default base class for aliases.

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

Return the domain associated with original address.

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

Map this alias to its ultimate destination.

Parameters
aliasmap:dict mapping bytes to AliasBaseA mapping of username to alias or group of aliases.
memo:None or dict of AliasBaseA record of the aliases already considered in the resolution process. If provided, memo is modified to include this alias.
Returns
IMessage or NoneA message receiver for the ultimate destination or None for an invalid destination.
domains = (source)
original: Address = (source)

The original address being aliased.