API Documentation
\

\Horde_Imap_Client_Interaction_Client

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

Summary

Methods
Properties
Constants
__construct()
add()
__toString()
count()
getIterator()
getData()
escape()
verify()
getCommand()
$tag
No constants found
No protected methods found
$_data
N/A
No private methods found
No private properties found
N/A

Properties

$tag

$tag : string

The command tag.

Type

string

$_data

$_data : mixed

Data.

Type

mixed

Methods

__construct()

__construct(string  $tag = null)

Constructor.

Parameters

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

getCommand()

getCommand() : string

Get the command.

Returns

string —

The command.