twisted.mail.pop3.IServerFactory : API documentation

An interface for querying capabilities of a POP3 server.

Any cap_* method may raise NotImplementedError if the particular capability is not supported. If cap_EXPIRE() does not raise NotImplementedError, perUserExpiration() must be implemented, otherwise they are optional. If cap_LOGIN_DELAY() is implemented, perUserLoginDelay() must be implemented, otherwise they are optional.

Instance Variable	challengers	A mapping of challenger names to `IUsernameHashedPassword` provider. (type: `dict` of `bytes` -> `IUsernameHashedPassword`)
Method	cap_IMPLEMENTATION	Return a string describing the POP3 server implementation.
Method	cap_EXPIRE	Return the minimum number of days messages are retained.
Method	perUserExpiration	Indicate whether the message expiration policy differs per user.
Method	cap_LOGIN_DELAY	Return the minimum number of seconds between client logins.
Method	perUserLoginDelay	Indicate whether the login delay period differs per user.

challengers =

A mapping of challenger names to IUsernameHashedPassword provider. (type: dict of bytes -> IUsernameHashedPassword)

def cap_IMPLEMENTATION(): (source)

Return a string describing the POP3 server implementation.

Returns Server implementation information. (type: bytes)

def cap_EXPIRE(): (source)

Return the minimum number of days messages are retained.

Returns The minimum number of days messages are retained or none, if the server never deletes messages. (type: int or NoneType)

def perUserExpiration(): (source)

Indicate whether the message expiration policy differs per user.

Returns True when the message expiration policy differs per user, False otherwise. (type: bool)

def cap_LOGIN_DELAY(): (source)

Return the minimum number of seconds between client logins.

Returns The minimum number of seconds between client logins. (type: int)

def perUserLoginDelay(): (source)

Indicate whether the login delay period differs per user.

Returns True when the login delay differs per user, False otherwise. (type: bool)

twisted.mail.pop3.IServerFactory(Interface) interface documentation