\Horde_Imap_Client_Interaction_Pipeline

An object representing a series of IMAP client commands (RFC 3501 [2.2.1]) to be processed at the same time.

Summary

Methods
Properties
Constants
__construct()
__get()
add()
complete()
getCmd()
count()
getIterator()
$data
$fetch
$finished
No constants found
No protected methods found
$_commands
$_todo
N/A
No private methods found
No private properties found
N/A

Properties

$data

$data : array

Data storage from server responses.

Type

array

$finished

$finished : boolean

True if all commands have finished.

Type

boolean

$_commands

$_commands : array

The list of commands.

Type

array

$_todo

$_todo : array

The list of commands to complete.

Type

array

Methods

__get()

__get(  $name) 

Parameters

$name

add()

add(\Horde_Imap_Client_Interaction_Command  $cmd, boolean  $top = false) 

Add a command to the pipeline.

Parameters

\Horde_Imap_Client_Interaction_Command $cmd

Command object.

boolean $top

Add command to top of queue?

getCmd()

getCmd(string  $tag) : \Horde_Imap_Client_Interaction_Command

Return the command for a given tag.

Parameters

string $tag

The command tag.

Returns

\Horde_Imap_Client_Interaction_Command

A command object (or null if the tag does not exist).

count()

count() 

getIterator()

getIterator()