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

Optional parameters:

  '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.

If setting up as Horde auth handler in conf.php, this is a sample entry:

   $conf['auth']['params']['hostspec'] = 'imap.example.com';
   $conf['auth']['params']['port'] = 143;
   $conf['auth']['params']['protocol'] = 'imap/notls/novalidate-cert';

$Horde: framework/Auth/Auth/imap.php,v 1.28.10.15 2009/01/06 15:22:49 jan Exp $

Copyright 1999-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://opensource.org/licenses/lgpl-license.php.

• author: Chuck Hagenbuch <chuck@horde.org>
• author: Gaudenz Steinlin <gaudenz@soziologie.ch>
• author: Jan Schneider <jan@horde.org>
• since: Horde 1.3

Located in /Auth/Auth/imap.php (line 48)

Auth
   |
   --Auth_imap

Inherited Variables

Inherited from Auth

Auth::$capabilities
Auth::$_authCredentials
Auth::$_params

Constructor Auth_imap (line 55)

Constructs a new IMAP authentication object.

Auth_imap Auth_imap ([array $params = array()])

• array $params: A hash containing connection parameters.

addUser (line 135)

Add a set of authentication credentials.

• return: True on success or a PEAR_Error object on failure.

mixed addUser (string $userId, array $credentials)

• string $userId: The userId to add.
• array $credentials: The credentials to use.

---

Redefinition of:

Auth::addUser()

Adds a set of authentication credentials.

listUsers (line 165)

List all users in the system.

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

mixed listUsers ()

---

Redefinition of:

Auth::listUsers()

Lists all users in the system.

removeUser (line 149)

Delete a set of authentication credentials.

• return: True on success or a PEAR_Error object on failure.

mixed removeUser (string $userId)

• string $userId: The userId to delete.

---

Redefinition of:

Auth::removeUser()

Deletes a set of authentication credentials.

Inherited Methods

Inherited From Auth

Auth::addHook()
Auth::addLogoutParameters()
Auth::addUser()
Auth::authenticate()
Auth::clearAuth()
Auth::exists()
Auth::factory()
Auth::genRandomPassword()
Auth::getAuth()
Auth::getAuthDomain()
Auth::getBareAuth()
Auth::getCredential()
Auth::getCryptedPassword()
Auth::getDriver()
Auth::getLoginScreen()
Auth::getLogoutReason()
Auth::getLogoutReasonString()
Auth::getParam()
Auth::getProvider()
Auth::getSalt()
Auth::hasCapability()
Auth::isAdmin()
Auth::isAuthenticated()
Auth::isPasswordChangeRequested()
Auth::listUsers()
Auth::readSessionData()
Auth::removeHook()
Auth::removeUser()
Auth::removeUserData()
Auth::setAuth()
Auth::setCredential()
Auth::singleton()
Auth::transparent()
Auth::updateUser()
Auth::_authenticate()
Auth::_isAdmin()