twisted.mail.maildir.AbstractMaildirDomain : API documentation

A mapping of username to alias.

(type: None or dict mapping bytes to AliasBase)

def __init__(self, service, root): (source)

Parameters	service	An email service. (type: `MailService`)
	root	The maildir root directory. (type: `bytes`)

def userDirectory(self, user): (source)

Return the maildir directory for a user.

Parameters	user	A username. (type: `bytes`)
Returns	The user's mail directory for a valid user. Otherwise, `None`. (type: `bytes` or `None`)

def setAliasGroup(self, alias): (source)

Set the group of defined aliases for this domain.

Parameters alias A mapping of domain name to alias. (type: dict mapping bytes to IAlias provider.)

def exists(self, user, memo=None): (source)

Check whether a user exists in this domain or an alias of it.

Parameters	user	A user. (type: `User`)
	memo	A record of the addresses already considered while resolving aliases. The default value should be used by all external code. (type: `None` or `dict` of `AliasBase`)
Returns	A function which takes no arguments and returns a message receiver for the user. (type: no-argument callable which returns `IMessage` provider.)
Raises	SMTPBadRcpt	When the given user does not exist in this domain or an alias of it.

def startMessage(self, user): (source)

Create a maildir message for a user.

Parameters	user	A username. (type: `bytes`)
Returns	A message receiver for this user. (type: `MaildirMessage`)

def willRelay(self, user, protocol): (source)

Check whether this domain will relay.

Parameters	user	The destination address. (type: `Address`)
	protocol	The protocol over which the message to be relayed is being received. (type: `SMTP`)
Returns	An indication of whether this domain will relay the message to the destination. (type: `bool`)

def addUser(self, user, password): (source)

Add a user to this domain.

Subclasses should override this method.

Parameters	user	A username. (type: `bytes`)
	password	A password. (type: `bytes`)

def getCredentialsCheckers(self): (source)

Return credentials checkers for this domain.

Subclasses should override this method.

Returns Credentials checkers for this domain. (type: list of ICredentialsChecker provider)

Instance Variable	alias	A mapping of username to alias.
Instance Variable	root	See `__init__`.
Method	__init__
Method	userDirectory	Return the maildir directory for a user.
Method	setAliasGroup	Set the group of defined aliases for this domain.
Method	exists	Check whether a user exists in this domain or an alias of it.
Method	startMessage	Create a maildir message for a user.
Method	willRelay	Check whether this domain will relay.
Method	addUser	Add a user to this domain.
Method	getCredentialsCheckers	Return credentials checkers for this domain.