t.m.m.AbstractMaildirDomain : class documentation

Part of twisted.mail.maildir View Source View In Hierarchy

Known subclasses: twisted.mail.maildir.MaildirDirdbmDomain

Implements interfaces: twisted.mail.mail.IAliasableDomain

Abstract maildir-backed domain.
Method __init__ Initialize.
Method userDirectory Get the maildir directory for the given user.
Method setAliasGroup Set the group of defined aliases for this domain
Method exists Check for existence of user in the domain.
Method startMessage Save a message for the given user.
Method willRelay Undocumented
Method addUser Add a username/password to this domain.
Method getCredentialsCheckers Return a list of ICredentialsChecker implementors for this domain.
def __init__(self, service, root): (source)
overridden in twisted.mail.maildir.MaildirDirdbmDomain
Initialize.
def userDirectory(self, user): (source)
overridden in twisted.mail.maildir.MaildirDirdbmDomain
Get the maildir directory for the given user.

Override to specify where to save mails for users. Return None for non-existing users.

def setAliasGroup(self, alias): (source)
from twisted.mail.mail.IAliasableDomain
Set the group of defined aliases for this domain
ParametersaliasesMapping of domain names to objects implementing IAlias (type: dict)
def exists(self, user, memo=None): (source)
from twisted.mail.mail.IAliasableDomain
Check for existence of user in the domain.
def startMessage(self, user): (source)
from twisted.mail.mail.IDomain
Save a message for the given user.
def willRelay(self, user, protocol): (source)
Undocumented
def addUser(self, user, password): (source)
from twisted.mail.mail.IDomain
overridden in twisted.mail.maildir.MaildirDirdbmDomain
Add a username/password to this domain.
def getCredentialsCheckers(self): (source)
from twisted.mail.mail.IDomain
overridden in twisted.mail.maildir.MaildirDirdbmDomain
Return a list of ICredentialsChecker implementors for this domain.
API Documentation for Twisted, generated by pydoctor at 2013-04-03 11:20:05.