API Documentation
\

\Horde_Imap_Client_Data_Capability_Imap

Query the capabilities of an IMAP server.

Summary

Methods
Properties
Constants
add()
remove()
query()
getParams()
isEnabled()
toArray()
attach()
detach()
notify()
serialize()
unserialize()
__get()
enable()
$cmdlength
No constants found
No protected methods found
$_data
$_observers
$_enabled
N/A
No private methods found
No private properties found
N/A

Properties

$cmdlength

$cmdlength : integer

Allowable command length (in octets).

Type

integer

$_data

$_data : array

Capability data.

Type

array

$_observers

$_observers : array

Observers.

Type

array

$_enabled

$_enabled : array

The list of enabled extensions.

Type

array

Methods

add()

add(string  $capability, mixed  $params = null)

Add a capability (and optional parameters).

Parameters

string $capability

The capability to add.
mixed $params

A parameter (or array of parameters) to add.

remove()

remove(string  $capability, string  $params = null)

Remove a capability.

Parameters

string $capability

The capability to remove.
string $params

A parameter (or array of parameters) to remove from the capability.

query()

query(string  $capability, string  $parameter = null) : boolean

Returns whether the server supports the given capability.

Parameters

string $capability

The capability string to query.
string $parameter

If set, require the parameter to exist.

Returns

boolean —

True if the capability (and parameter) exist.

getParams()

getParams(string  $capability) : array

Return the list of parameters for an extension.

Parameters

string $capability

The capability string to query.

Returns

array —

An array of parameters if the extension exists and supports parameters. Otherwise, an empty array.

isEnabled()

isEnabled(string  $capability = null) : mixed

Is the extension enabled?

Parameters

string $capability

The extension (+ parameter) to query. If null, returns all enabled extensions.

Returns

mixed —

If $capability is null, return all enabled extensions. Otherwise, true if the extension (+ parameter) is enabled.

toArray()

toArray() : array

Returns the raw data.

Returns

array —

Capability data.

attach()

attach(\SplObserver  $observer)

Parameters

\SplObserver $observer

detach()

detach(\SplObserver  $observer)

Parameters

\SplObserver $observer

notify()

notify()

Notification is triggered internally whenever the object's internal data storage is altered.

serialize()

serialize()

unserialize()

unserialize(  $data)

Parameters

$data

__get()

__get(  $name)

Parameters

$name

enable()

enable(array  $capability, boolean  $enable = true)

Set a capability as enabled/disabled.

Parameters

array $capability

A capability (+ parameter).
boolean $enable

If true, enables the capability.