The Kolab implementation of the Horde authentication system. Derives from the Auth_imap IMAP authentication object, and provides parameters to it based on the global Kolab configuration.

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

Copyright 2004-2007 Stuart Binge <s.binge@codefusion.co.za> Copyright 2008-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: Gunnar Wrobel <wrobel@pardus.de>
• author: Stuart Binge <s.binge@codefusion.co.za>
• since: Horde 1.3

Located in /Auth/Auth/kolab.php (line 21)

Auth
   |
   --Auth_kolab

array $capabilities = array('add' => true,
'update' => false,
'resetpassword' => false,
'remove' => false,
'list' => true,
'transparent' => false) (line 29)

An array of capabilities, so that the driver can report which operations it supports and which it doesn't.

---

Redefinition of:

Auth::$capabilities

An array of capabilities, so that the driver can report which operations it supports and which it doesn't.

Inherited Variables

Inherited from Auth

Auth::$_authCredentials
Auth::$_params

addUser (line 195)

Add a set of authentication credentials.

• return: True on success.

boolean|PEAR_Error addUser (string $userId, array $credentials)

• string $userId: The userId to add.
• array $credentials: The credentials to be set.

---

Redefinition of:

Auth::addUser()

Adds a set of authentication credentials.

listUsers (line 166)

List Users

• return: List of Users

array listUsers ()

---

Redefinition of:

Auth::listUsers()

Lists all users in the system.

setAuth (line 149)

Sets a variable in the session saying that authorization has succeeded, note which userId was authorized, and note when the login took place.

The kolab driver rewrites UIDs into the correct mail addresses that need to be used to log into the IMAP server.

void setAuth (string $userId, array $credentials, [string $realm = null], [boolean $changeRequested = false])

• string $userId: The userId who has been authorized.
• array $credentials: The credentials of the user.
• string $realm: The authentication realm to use.
• boolean $changeRequested: Whether to request that the user change their password.

---

Redefinition of:

Auth::setAuth()

Sets a variable in the session saying that authorization has succeeded, note which userId was authorized, and note when the login took place.

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()