API Documentation
\

\Horde_Imsp_Auth_Imtest

IMSP authentication class for authentication through imtest.

Required parameters:

'username'        Username to logon to IMSP server as.
'password'        Password for current user.
'server'          The hostname of the IMSP server.
'port'            The port of the IMSP server.
'socket'          The named socket to use for connection
'command'         Path to the imtest command on localhost
'auth_mechanism'  Authentication method to use with imtest

Summary

Methods
Properties
Constants
__construct()
authenticate()
getDriverType()
logout()
No public properties found
No constants found
_authenticate()
$_params
$_imsp
N/A
No private methods found
No private properties found
N/A

Properties

$_params

$_params :

Type

$_imsp

$_imsp : \Horde_Imsp_Client_Base

Class variable to hold the resulting Horde_Imsp object

Type

\Horde_Imsp_Client_Base

Methods

__construct()

__construct(array  $params = array())

Constructor

Parameters

array $params

authenticate()

authenticate(\Horde_Imsp_Client_Base  $client, boolean  $login = true) : boolean

Attempts to login to IMSP server.

Parameters

\Horde_Imsp_Client_Base $client

The Imsp client connection.
boolean $login

Remain logged in after auth?

Returns

boolean

getDriverType()

getDriverType() : string

Returns the driver type.

Returns

string —

The type of this IMSP_Auth driver.

logout()

logout()

Force a logout command to the imsp stream.

_authenticate()

_authenticate() : boolean

Private authentication function. Provides actual authentication code.

Returns

boolean