Horde 3.1.3 : Vue détaillée de imap.php

Classe: Auth_imap - X-Ref

The Auth_imap:: class provides an IMAP implementation of the Horde
authentication system.

Optional parameters:<pre>
'hostspec'        The hostname or IP address of the server.
DEFAULT: 'localhost'
'port'            The server port to which we will connect.
IMAP is generally 143, while IMAP-SSL is generally 993.
DEFAULT: 143
'protocol'        The connection protocol (e.g. 'imap', 'pop3', 'nntp').
Protocol is one of 'imap/notls' (or only 'imap' if you
have a c-client version 2000c or older), 'imap/ssl',
or 'imap/ssl/novalidate-cert' (for a self-signed
certificate).
DEFAULT: 'imap'
'admin_user'      The name of a user with admin privileges.
DEFAULT: null
'admin_password'  The password of the adminstrator.
DEFAULT: null
'userhierarchy'   The hierarchy where user mailboxes are stored.
DEFAULT: 'user.'
'dsn'             The full IMAP connection string.
If not present, this is built from 'hostspec', 'port'
and 'protocol' parameters.</pre>

If setting up as Horde auth handler in conf.php, this is a sample entry:<pre>
$conf['auth']['params']['hostspec'] = 'imap.example.com';
$conf['auth']['params']['port'] = 143;
$conf['auth']['params']['protocol'] = 'imap/notls/novalidate-cert';</pre>

$Horde: framework/Auth/Auth/imap.php,v 1.28.10.9 2006/05/31 19:39:48 slusarz Exp $

Copyright 1999-2006 Chuck Hagenbuch <chuck@horde.org>
Copyright 1999-2006 Gaudenz Steinlin <gaudenz.steinlin@id.unibe.ch>
Copyright 2004-2006 Jan Schneider <jan@horde.org>

See the enclosed file COPYING for license information (LGPL). If you
did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Auth_imap($params = array() X-Ref

Constructs a new IMAP authentication object.

param: array $params A hash containing connection parameters.

_authenticate($userId, $credentials) X-Ref

Find out if a set of login credentials are valid.

param: string $userId      The userId to check.
param: array $credentials  An array of login credentials. For IMAP,
return: boolean  Whether or not the credentials are valid.

addUser($userId, $credentials) X-Ref

Add a set of authentication credentials.

param: string $userId       The userId to add.
param: array  $credentials  The credentials to use.
return: mixed  True on success or a PEAR_Error object on failure.

removeUser($userId) X-Ref

Delete a set of authentication credentials.

param: string $userId The userId to delete.
return: mixed True on success or a PEAR_Error object on failure.

listUsers() X-Ref

List all users in the system.

return: mixed The array of userIds, or a PEAR_Error object on failure.

Poids:	160 lignes (6 kb)
Inclus ou requis:	0 fois
Référencé:	0 fois
Nécessite:	0 fichiers

Code source de Horde 3.1.3

/lib/Horde/Auth/ -> imap.php (sommaire)

Définit 1 class