Horde_Imap_Client_Interaction_Command
extends Horde_Imap_Client_Data_Format_List
in package
An object representing an IMAP command (RFC 3501 [2.2.1]).
Tags
Table of Contents
- $continuation : bool
- $debug : array<string|int, mixed>
- Debug string(s) to use instead of command text.
- $literal8 : bool
- Are literal8's available?
- $literalplus : bool
- Use LITERAL+ if available
- $on_error : callable
- A callback to run on error.
- $on_success : callable
- A callback to run on success.
- $pipeline : Horde_Imap_Client_Interaction_Pipeline
- Pipeline object associated with this command.
- $response : Horde_Imap_Client_Interaction_Server
- Server response.
- $tag : string
- The command tag.
- $_data : mixed
- Data.
- $_timer : Horde_Support_Timer
- Command timer.
- __construct() : mixed
- Constructor.
- __get() : mixed
- __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.
- getTimer() : mixed
- Return the timer data.
- startTimer() : mixed
- Start the command timer.
- verify() : mixed
- Verify the data.
- _continuationCheck() : mixed
- Recursive check for continuation functions.
Properties
$continuation read-only
public
bool
$continuation
True if the command requires a server continuation response.
$debug
Debug string(s) to use instead of command text.
public
array<string|int, mixed>
$debug
= array()
Multiple entries refer to the various steps in a continuation command.
$literal8
Are literal8's available?
public
bool
$literal8
= \false
$literalplus
Use LITERAL+ if available
public
bool
$literalplus
= \true
$on_error
A callback to run on error.
public
callable
$on_error
= \null
If callback returns true, the command will be treated as successful.
Tags
$on_success
A callback to run on success.
public
callable
$on_success
= \null
Tags
$pipeline
Pipeline object associated with this command.
public
Horde_Imap_Client_Interaction_Pipeline
$pipeline
Tags
$response
Server response.
public
Horde_Imap_Client_Interaction_Server
$response
$tag
The command tag.
public
string
$tag
$_data
Data.
protected
mixed
$_data
$_timer
Command timer.
protected
Horde_Support_Timer
$_timer
Methods
__construct()
Constructor.
public
__construct(string $cmd[, string $tag = null ]) : mixed
Parameters
- $cmd : string
-
The IMAP command.
- $tag : string = null
-
The tag to use. If not set, will be automatically generated.
Return values
mixed —__get()
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
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 —getTimer()
Return the timer data.
public
getTimer() : mixed
Return values
mixed —Null if timer wasn't started, or a float containing elapsed command time.
startTimer()
Start the command timer.
public
startTimer() : mixed
Return values
mixed —verify()
Verify the data.
public
verify() : mixed
Tags
Return values
mixed —_continuationCheck()
Recursive check for continuation functions.
protected
_continuationCheck(mixed $list) : mixed
Parameters
- $list : mixed