Horde_Imap_Client_Interaction_Client
extends Horde_Imap_Client_Data_Format_List
in package
An object representing an IMAP client command interaction (RFC 3501 [2.2.1]).
Tags
Table of Contents
- $tag : string
- The command tag.
- $_data : mixed
- Data.
- __construct() : mixed
- Constructor.
- __toString() : string
- Returns the string value of the raw data.
- add() : Horde_Imap_Client_Data_Format_List
- Add an element to the list.
- count() : mixed
- escape() : string
- Returns the data formatted for output to the IMAP server.
- getCommand() : string
- Get the command.
- getData() : mixed
- Returns the raw data.
- getIterator() : mixed
- Iterator loops through the data elements contained in this list.
- verify() : mixed
- Verify the data.
Properties
$tag
The command tag.
public
string
$tag
$_data
Data.
protected
mixed
$_data
Methods
__construct()
Constructor.
public
__construct([string $tag = null ]) : mixed
Parameters
- $tag : string = null
-
The tag to use. If not set, will be automatically generated.
Return values
mixed —__toString()
Returns the string value of the raw data.
public
__toString() : string
Return values
string —String value.
add()
Add an element to the list.
public
add(mixed $data[, bool $merge = false ]) : Horde_Imap_Client_Data_Format_List
Parameters
- $data : mixed
-
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.
- $merge : bool = false
-
Merge the contents of any container objects, instead of adding the objects themselves?
Return values
Horde_Imap_Client_Data_Format_List —This object to allow for chainable calls (since 2.10.0).
count()
public
count() : mixed
Return values
mixed —escape()
Returns the data formatted for output to the IMAP server.
public
escape() : string
Return values
string —IMAP escaped string.
getCommand()
Get the command.
public
getCommand() : string
Return values
string —The command.
getData()
Returns the raw data.
public
getData() : mixed
Return values
mixed —Raw data.
getIterator()
Iterator loops through the data elements contained in this list.
public
getIterator() : mixed
Return values
mixed —verify()
Verify the data.
public
verify() : mixed