API Documentation
\

\Horde_Kolab_Session_Imap

The Horde_Kolab_Session_Imap class relies on predefined Kolab user details and validates the credentials against the IMAP server only.

Copyright 2011-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
Properties
Constants
getId()
getMail()
getUid()
getName()
getImapServer()
getFreebusyServer()
import()
export()
purge()
__construct()
connect()
No public properties found
No constants found
No protected methods found
$_data
N/A
No private methods found
$_params
$_imap
N/A

Properties

$_data

$_data : array

The session data.

Type

array

$_params

$_params : array

Kolab configuration parameters.

Type

array

Methods

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

__construct()

__construct(\Horde_Kolab_Session_Factory_Imap  $imap, array  $params)

Constructor.

Parameters

\Horde_Kolab_Session_Factory_Imap $imap

The imap driver factory.
array $params

Kolab configuration settings.

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