t.m.m.IDomain(Interface) : interface documentation

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

Known subclasses: twisted.mail.mail.IAliasableDomain

Known implementations: twisted.mail.mail.BounceDomain

An email domain.
Method exists Check whether or not the specified user exists in this domain.
Method addUser Add a username/password to this domain.
Method startMessage Create and return a new message to be delivered to the given user.
Method getCredentialsCheckers Return a list of ICredentialsChecker implementors for this domain.
def exists(user): (source)
Check whether or not the specified user exists in this domain.
ParametersuserThe user to check (type: twisted.protocols.smtp.User )
ReturnsA Deferred which becomes, or a callable which takes no arguments and returns an object implementing IMessage. This will be called and the returned object used to deliver the message when it arrives. (type: No-argument callable )
Raisestwisted.protocols.smtp.SMTPBadRcptRaised if the given user does not exist in this domain.
def addUser(user, password): (source)
Add a username/password to this domain.
def startMessage(user): (source)

Create and return a new message to be delivered to the given user.

DEPRECATED. Implement validateTo() correctly instead.
def getCredentialsCheckers(): (source)
Return a list of ICredentialsChecker implementors for this domain.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:02:37.