\Horde_Kolab_Session_Decorator_Anonymous

The Horde_Kolab_Session_Anonymous class allows anonymous access to the Kolab system.

Copyright 2009-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
__construct()
connect()
getId()
getMail()
getUid()
getName()
getImapServer()
getFreebusyServer()
import()
export()
purge()
No public properties found
No constants found
No protected methods found
$_session
N/A
No private methods found
$_anonymous_id
$_anonymous_pass
N/A

Properties

$_session

$_session : \Horde_Kolab_Session

The session handler this instance provides with anonymous access.

Type

\Horde_Kolab_Session

$_anonymous_id

$_anonymous_id : string

Anonymous user ID.

Type

string

$_anonymous_pass

$_anonymous_pass : string

Anonymous password.

Type

string

Methods

__construct()

__construct(\Horde_Kolab_Session  $session, string  $user, string  $pass) 

Constructor.

Parameters

\Horde_Kolab_Session $session

The this instance should provide anonymous access for.

string $user

ID of the anonymous user.

string $pass

Password of the anonymous user.

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