API Documentation
\

\Horde_Imap_Client_Interaction_Command

An object representing an IMAP command (RFC 3501 [2.2.1]).

Summary

Methods
Properties
Constants
__construct()
add()
__toString()
count()
getIterator()
getData()
escape()
verify()
__get()
getCommand()
startTimer()
getTimer()
$debug
$literalplus
$literal8
$on_error
$on_success
$pipeline
$response
$tag
$continuation
No constants found
_continuationCheck()
$_data
$_timer
N/A
No private methods found
No private properties found
N/A

Properties

$debug

$debug : array

Debug string(s) to use instead of command text.

Multiple entries refer to the various steps in a continuation command.

Type

array

$literalplus

$literalplus : boolean

Use LITERAL+ if available

Type

boolean

$literal8

$literal8 : boolean

Are literal8's available?

Type

boolean

$on_error

$on_error : callback

A callback to run on error.

If callback returns true, the command will be treated as successful.

Type

callback

$on_success

$on_success : callback

A callback to run on success.

Type

callback

$tag

$tag : string

The command tag.

Type

string

$continuation

$continuation : boolean

True if the command requires a server continuation response.

Type

boolean

$_data

$_data : mixed

Data.

Type

mixed

$_timer

$_timer : \Horde_Support_Timer

Command timer.

Type

\Horde_Support_Timer

Methods

__construct()

__construct(string  $cmd, string  $tag = null)

Constructor.

Parameters

string $cmd

The IMAP command.
string $tag

The tag to use. If not set, will be automatically generated.

add()

add(mixed  $data, boolean  $merge = false) : \Horde_Imap_Client_Data_Format_List

Add an element to the list.

Parameters

mixed $data

The data element(s) to add. Either a Horde_Imap_Client_Data_Format object, a string value that will be treated as an IMAP atom, or an array (or iterable object) of objects to add.
boolean $merge

Merge the contents of any container objects, instead of adding the objects themselves?

Returns

\Horde_Imap_Client_Data_Format_List —

This object to allow for chainable calls (since 2.10.0).

__toString()

__toString() : string

Returns the string value of the raw data.

Returns

string —

String value.

count()

count()

getIterator()

getIterator()

Iterator loops through the data elements contained in this list.

getData()

getData() : mixed

Returns the raw data.

Returns

mixed —

Raw data.

escape()

escape() : string

Returns the data formatted for output to the IMAP server.

Returns

string —

IMAP escaped string.

verify()

verify()

Verify the data.

Throws

\Horde_Imap_Client_Data_Format_Exception

__get()

__get(  $name)

Parameters

$name

getCommand()

getCommand() : string

Get the command.

Returns

string —

The command.

startTimer()

startTimer()

Start the command timer.

getTimer()

getTimer() : mixed

Return the timer data.

Returns

mixed —

Null if timer wasn't started, or a float containing elapsed command time.

_continuationCheck()

_continuationCheck(  $list)

Recursive check for continuation functions.

Parameters

$list