twisted.mail.maildir.DirdbmDatabase : API documentation

class documentation

class twisted.mail.maildir.DirdbmDatabase: (source)

A credentials checker which authenticates users out of a DirDBM database.

Instance Variable	dirdbm	An authentication database.
Class Variable	credentialInterfaces	A list of sub-interfaces of `ICredentials` which specifies which I may check.
Method	__init__
Method	requestAvatarId	Authenticate a user and, if successful, return their username.

An authentication database.

(type: DirDBM)

credentialInterfaces = (source)

A list of sub-interfaces of ICredentials which specifies which I may check.

def __init__(self, dbm): (source)

Parameters dbm An authentication database. (type: DirDBM)

def requestAvatarId(self, c): (source)

Authenticate a user and, if successful, return their username.

Parameters	c	Credentials. (type: `IUsernamePassword` or `IUsernameHashedPassword` provider.)
Returns	A string which identifies an user. (type: `bytes`)
Raises	UnauthorizedLogin	When the credentials check fails.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.