twisted.mail.alias.AliasGroup : API documentation

class documentation

class AliasGroup(AliasBase): (source)

An alias which points to multiple destination aliases.

Instance Variable	`processAliasFactory`	A factory for process aliases.
Instance Variable	`aliases`	The 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.

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.

processAliasFactory = (source)

A factory for process aliases.

(type: no-argument callable which returns ProcessAlias)

The destination aliases.

(type: list of AliasBase which implements IAlias)

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	Aliases. (type: `list` of `bytes`)
	args	Arguments for `AliasBase.__init__`. (type: n-`tuple` of (0) `dict` mapping `bytes` to `IDomain` provider, (1) `bytes`)

def __len__(self): (source)

Return the number of aliases in the group.

Returns The number of aliases in the group. (type: int)

def __str__(self): (source)

Build a string representation of this AliasGroup instance.

Returns A string containing the aliases in the group. (type: bytes)

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 A message receiver which passes a message on to message receivers for each alias in the group. (type: MultiWrapper)

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	A mapping of username to alias or group of aliases. (type: `dict` mapping `bytes` to `AliasBase`)
	memo	A record of the aliases already considered in the resolution process. If provided, `memo` is modified to include this alias. (type: `None` or `dict` of `AliasBase`)
Returns	A message receiver which passes the message on to message receivers for the ultimate destination of each alias in the group. (type: `MultiWrapper`)

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