twisted.mail.alias.AliasGroup

class documentation

class AliasGroup(AliasBase): (source)

Constructor: AliasGroup(items, *args)

Implements interfaces: twisted.mail.interfaces.IAlias

View In Hierarchy

An alias which points to multiple destination aliases.

Method __init__ Create a group of aliases.
Method __len__ Return the number of aliases in the group.
Method __str__ Build a string representation of this AliasGroup instance.
Method createMessageReceiver Create a message receiver for each alias and return a message receiver which will pass on a message to each of those.
Method resolve Map each of the aliases in the group to its ultimate destination.
Instance Variable aliases The destination aliases.
Instance Variable processAliasFactory A factory for process aliases.

Inherited from AliasBase:

Method domain Return the domain associated with original address.
Instance Variable domains See __init__.
Instance Variable original The original address being aliased.
def __init__(self, items, *args): (source)
overrides twisted.mail.alias.AliasBase.__init__

Create a group of aliases.

Parse a list of alias strings and, for each, create an appropriate alias object.

Parameters
items:list of bytesAliases.
*args:n-tuple of (0) dict mapping bytes to IDomain provider, (1) bytesArguments for AliasBase.__init__.
def __len__(self): (source)

Return the number of aliases in the group.

Returns
intThe number of aliases in the group.
def __str__(self) -> str: (source)

Build a string representation of this AliasGroup instance.

Returns
bytesA string containing the aliases in the group.
def createMessageReceiver(self): (source)
from twisted.mail.interfaces.IAlias

Create a message receiver for each alias and return a message receiver which will pass on a message to each of those.

Returns
MultiWrapperA message receiver which passes a message on to message receivers for each alias in the group.
def resolve(self, aliasmap, memo=None): (source)
overrides twisted.mail.alias.AliasBase.resolve

Map each of the aliases in the group 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
MultiWrapperA message receiver which passes the message on to message receivers for the ultimate destination of each alias in the group.
aliases: list of AliasBase which implements IAlias = (source)

The destination aliases.

processAliasFactory: no-argument callable which returns ProcessAlias = (source)

A factory for process aliases.