twisted.mail.maildir.AbstractMaildirDomain
class documentationtwisted.mail.maildir
View Source
(View In Hierarchy)
Known subclasses: twisted.mail.maildir.MaildirDirdbmDomain
Implements interfaces: twisted.mail.interfaces.IAliasableDomain
An abstract maildir-backed domain.
Instance Variable | alias | A mapping of username to alias. (type: None
or dict
mapping bytes
to AliasBase ) |
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. |
Parameters | service | An email service. (type: MailService ) |
root | The maildir root directory. (type: bytes ) |
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. |
Create a maildir message for a user.
Parameters | user | A username. (type: bytes ) |
Returns | A message receiver for this user. (type: MaildirMessage ) |
Return credentials checkers for this domain.
Subclasses should override this method.
Returns | Credentials checkers for this domain. (type: list
of ICredentialsChecker
provider) |