API Documentation
\

\Horde_Imap_Client_Data_Thread

Object representing the threaded sort results from Horde_Imap_Client_Base#thread().

Summary

Methods
Properties
Constants
__construct()
getType()
messageList()
getThread()
count()
serialize()
unserialize()
No public properties found
No constants found
_getAllIndices()
$_thread
$_type
N/A
No private methods found
No private properties found
N/A

Properties

$_thread

$_thread : array

Internal thread data structure. Keys are base values, values are arrays with keys as the ID and values as the level.

Type

array

$_type

$_type : string

The index type.

Type

string

Methods

__construct()

__construct(array  $data, string  $type)

Constructor.

Parameters

array $data

See $_thread.
string $type

Either 'sequence' or 'uid'.

getType()

getType() : string

Return the ID type.

Returns

string —

Either 'sequence' or 'uid'.

messageList()

messageList() : \Horde_Imap_Client_Ids

Return the sorted list of messages indices.

Returns

\Horde_Imap_Client_Ids —

The sorted list of messages.

getThread()

getThread(integer  $index) : array

Returns the list of messages in a thread.

Parameters

integer $index

An index contained in the thread.

Returns

array —

Keys are indices, values are objects with the following properties:

  • base: (integer) Base ID of the thread. If null, thread is a single message.
  • last: (boolean) If true, this is the last index in the sublevel.
  • level: (integer) The sublevel of the index.

count()

count()

serialize()

serialize()

unserialize()

unserialize(  $data)

Parameters

$data

_getAllIndices()

_getAllIndices() : array

Return all indices.

Returns

array —

An array of indices.