PHP Class Horde_Auth_Imap, horde

Author: Chuck Hagenbuch ([email protected])

Author: Gaudenz Steinlin ([email protected])

Author: Jan Schneider ([email protected])

Inheritance: extends Horde_Auth_Base

Protected Properties

Property	Type	Description
$_imap	array()	Imap client objects.

Method	Description
__construct ( array $params = [] )	Constructor.
addUser ( string $userId, array $credentials )	Add a set of authentication credentials.
listUsers ( boolean $sort = false ) : array	Lists all users in the system.
removeUser ( string $userId )	Delete a set of authentication credentials.

Method	Description
_authenticate ( string $userId, array $credentials )	Find out if a set of login credentials are valid.
_getOb ( string $user, string $pass ) : Horde_Imap_Client_Base	Get Horde_Imap_Client object.

Constructor.

public __construct ( array $params = [] )
$params	array	Optional parameters: - admin_password: (string) The password of the administrator. DEFAULT: null - admin_user: (string) The name of a user with admin privileges. DEFAULT: null - hostspec: (string) The hostname or IP address of the server. DEFAULT: 'localhost' - port: (integer) The server port to which we will connect. IMAP is generally 143, while IMAP-SSL is generally 993. DEFAULT: Encryption port default - secure: (string) The encryption to use. Either 'none', 'ssl', or 'tls'. DEFAULT: 'none' - userhierarchy: (string) The hierarchy where user mailboxes are stored (UTF-8). DEFAULT: 'user.'

Find out if a set of login credentials are valid.

protected _authenticate ( string $userId, array $credentials )
$userId	string	The userId to check.
$credentials	array	An array of login credentials. For IMAP, this must contain a password entry.

Get Horde_Imap_Client object.

protected _getOb ( string $user, string $pass ) : Horde_Imap_Client_Base
$user	string	Username.
$pass	string	Password.
return	Horde_Imap_Client_Base	IMAP client object.

Add a set of authentication credentials.

public addUser ( string $userId, array $credentials )
$userId	string	The userId to add.
$credentials	array	The credentials to use.

Lists all users in the system.

public listUsers ( boolean $sort = false ) : array
$sort	boolean	Sort the users?
return	array	The array of userIds.

Delete a set of authentication credentials.

public removeUser ( string $userId )
$userId	string	The userId to delete.

Imap client objects.

protected array() $_imap
return	array()