twisted.mail.test.test_imap.TestRealm

class documentation

class TestRealm: (source)

Implements interfaces: twisted.cred.portal.IRealm

View In Hierarchy

A IRealm for tests.

Method __init__ Create a realm for testing.
Method requestAvatar Return avatar which provides one of the given interfaces.
Class Variable theAccount An Account instance. Tests can set this to ensure predictable account retrieval.
Instance Variable _getAccount Undocumented
def __init__(self, accountHolder=None): (source)

Create a realm for testing.

Parameters
accountHolder(optional) An object whose theAccount attribute will be returned instead of TestRealm.theAccount. Attribute access occurs on every avatar request, so any modifications to accountHolder.theAccount will be reflected here.
def requestAvatar(self, avatarId, mind, *interfaces): (source)
from twisted.cred.portal.IRealm

Return avatar which provides one of the given interfaces.

Parameters
avatarIda string that identifies an avatar, as returned by ICredentialsChecker.requestAvatarId (via a Deferred). Alternatively, it may be twisted.cred.checkers.ANONYMOUS.
mindusually None. See the description of mind in Portal.login.
*interfacesthe interface(s) the returned avatar should implement, e.g. IMailAccount. See the description of Portal.login.
Returns
a deferred which will fire a tuple of (interface, avatarAspect, logout), or the tuple itself. The interface will be one of the interfaces passed in the 'interfaces' argument. The 'avatarAspect' will implement that interface. The 'logout' object is a callable which will detach the mind from the avatar.
theAccount = (source)

An Account instance. Tests can set this to ensure predictable account retrieval.

_getAccount = (source)

Undocumented