API docs for “twisted.mail.alias”

Support for aliases(5) configuration files

API Stability: Unstable

Author

TODO:

   Monitor files for reparsing
   Handle non-local alias targets
   Handle maildir alias targets

Function	handle	Undocumented
Function	loadAliasFile	Load a file containing email aliases.
Interface	IAlias	Undocumented
Class	AliasBase	Undocumented
Class	AddressAlias	The simplest alias, translating one email address into another.
Class	FileWrapper	No class docstring; 3/5 methods documented
Class	FileAlias	Undocumented
Class	MessageWrapper	No class docstring; 3/6 methods documented
Class	ProcessAliasProtocol	No class docstring; 1/1 methods documented
Class	ProcessAlias	An alias for a program.
Class	MultiWrapper	Wrapper to deliver a single message to multiple recipients
Class	AliasGroup	An alias which points to more than one recipient

def handle(result, line, filename, lineNo): (source)

Undocumented

def loadAliasFile(domains, filename=None, fp=None): (source)

Load a file containing email aliases.

Lines in the file should be formatted like so:

   username: alias1,alias2,...,aliasN

Aliases beginning with a | will be treated as programs, will be run, and the message will be written to their stdin.

Aliases without a host part will be assumed to be addresses on localhost.

If a username is specified multiple times, the aliases for each are joined together as if they had all been on one line.

Parameters	domains	The domains to which these aliases will belong. (type: `dict` of implementor of `IDomain` )
	filename	The filename from which to load aliases. (type: `str` )
	fp	If specified, overrides `filename`, and aliases are read from it. (type: Any file-like object. )
Returns	A dictionary mapping usernames to `AliasGroup` objects. (type: `dict` )

Module t.m.alias