Horde_Imap_Client_Data_Capability_Imap
extends Horde_Imap_Client_Data_Capability
in package
Query the capabilities of an IMAP server.
Tags
Table of Contents
- $cmdlength : int
- $_data : array<string|int, mixed>
- Capability data.
- $_enabled : array<string|int, mixed>
- The list of enabled extensions.
- $_observers : array<string|int, mixed>
- Observers.
- __get() : mixed
- __serialize() : array<string|int, mixed>
- __unserialize() : mixed
- add() : mixed
- Add a capability (and optional parameters).
- attach() : mixed
- detach() : mixed
- enable() : mixed
- Set a capability as enabled/disabled.
- getParams() : array<string|int, mixed>
- Return the list of parameters for an extension.
- isEnabled() : mixed
- Is the extension enabled?
- notify() : mixed
- Notification is triggered internally whenever the object's internal data storage is altered.
- query() : bool
- Returns whether the server supports the given capability.
- remove() : mixed
- Remove a capability.
- serialize() : mixed
- toArray() : array<string|int, mixed>
- Returns the raw data.
- unserialize() : mixed
Properties
$cmdlength read-only
public
int
$cmdlength
Allowable command length (in octets).
$_data
Capability data.
protected
array<string|int, mixed>
$_data
= array()
$_enabled
The list of enabled extensions.
protected
array<string|int, mixed>
$_enabled
= array()
$_observers
Observers.
protected
array<string|int, mixed>
$_observers
= array()
Methods
__get()
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
Return values
mixed —__serialize()
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —__unserialize()
public
__unserialize(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
Return values
mixed —add()
Add a capability (and optional parameters).
public
add(string $capability[, mixed $params = null ]) : mixed
Parameters
- $capability : string
-
The capability to add.
- $params : mixed = null
-
A parameter (or array of parameters) to add.
Return values
mixed —attach()
public
attach(SplObserver $observer) : mixed
Parameters
- $observer : SplObserver
Return values
mixed —detach()
public
detach(SplObserver $observer) : mixed
Parameters
- $observer : SplObserver
Return values
mixed —enable()
Set a capability as enabled/disabled.
public
enable(array<string|int, mixed> $capability[, bool $enable = true ]) : mixed
Parameters
- $capability : array<string|int, mixed>
-
A capability (+ parameter).
- $enable : bool = true
-
If true, enables the capability.
Return values
mixed —getParams()
Return the list of parameters for an extension.
public
getParams(string $capability) : array<string|int, mixed>
Parameters
- $capability : string
-
The capability string to query.
Return values
array<string|int, mixed> —An array of parameters if the extension exists and supports parameters. Otherwise, an empty array.
isEnabled()
Is the extension enabled?
public
isEnabled([mixed $capability = null ]) : mixed
Parameters
- $capability : mixed = null
-
The extension (+ parameter) to query. If null, returns all enabled extensions.
Return values
mixed —If $capability is null, return all enabled extensions. Otherwise, true if the extension (+ parameter) is enabled.
notify()
Notification is triggered internally whenever the object's internal data storage is altered.
public
notify() : mixed
Return values
mixed —query()
Returns whether the server supports the given capability.
public
query(mixed $capability[, mixed $parameter = null ]) : bool
Parameters
- $capability : mixed
-
The capability string to query.
- $parameter : mixed = null
-
If set, require the parameter to exist.
Return values
bool —True if the capability (and parameter) exist.
remove()
Remove a capability.
public
remove(string $capability[, string $params = null ]) : mixed
Parameters
- $capability : string
-
The capability to remove.
- $params : string = null
-
A parameter (or array of parameters) to remove from the capability.
Return values
mixed —serialize()
public
serialize() : mixed
Return values
mixed —toArray()
Returns the raw data.
public
toArray() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —Capability data.
unserialize()
public
unserialize(mixed $data) : mixed
Parameters
- $data : mixed