API Documentation
\

\Horde_Kolab_Session

The interface describing Horde_Kolab_Session handlers.

Horde_Kolab_Server currently has no caching so we mainly cache some core user information in the Kolab session handler as reading this data is expensive and it is sufficient to read it once per session.

The users account id needs to be provided from the outside. Any additional Kolab user data relevant for the user session should be accessed via the Horde_Kolab_Session class.

Copyright 2008-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Summary

Methods
Constants
connect()
getId()
getMail()
getUid()
getName()
getImapServer()
getFreebusyServer()
import()
export()
purge()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

connect()

connect(string  $user_id = null, array  $credentials = null) : NULL

Try to connect the session handler.

Parameters

string $user_id

The user ID to connect with.
array $credentials

An array of login credentials. For Kolab, this must contain a "password" entry.

Throws

\Horde_Kolab_Session_Exception

If the connection failed.

Returns

NULL

getId()

getId() : string

Return the user id used for connecting the session.

Returns

string —

The user id.

getMail()

getMail() : string

Return the users mail address.

Returns

string —

The users mail address.

getUid()

getUid() : string

Return the users uid.

Returns

string —

The users uid.

getName()

getName() : string

Return the users name.

Returns

string —

The users name.

getImapServer()

getImapServer() : string

Return the imap server.

Returns

string —

The imap host for the current user.

getFreebusyServer()

getFreebusyServer() : string

Return the freebusy server.

Returns

string —

The freebusy host for the current user.

import()

import(array  $session_data) : NULL

Import the session data from an array.

Parameters

array $session_data

Returns

NULL

export()

export() : array

Export the session data as array.

Returns

array —

The session data.

purge()

purge() : NULL

Clear the session data.

Returns

NULL