rcube_result_multifolder

Class holding a set of rcube_result_index instances that together form a result set of a multi-folder search

package

Framework

subpackage

Storage

Methods

Object constructor.

__construct($folders = array()) 

Arguments

$folders

Initializes object with SORT command response

add($result) 

Arguments

$result

Append message UIDs from the given result to our index

append_result($result) 

Arguments

$result

Store a global index of (sorted) message UIDs

set_message_index($headers, $sort_field, $sort_order) 

Arguments

$headers

$sort_field

$sort_order

Checks the result from IMAP command

is_error() : bool

Response

bool

True if the result is an error, False otherwise

Checks if the result is empty

is_empty() : bool

Response

bool

True if the result is empty, False otherwise

Returns number of elements in the result

count() : int

Response

int

Number of elements

Returns number of elements in the result.

count_messages() : int

Alias for count() for compatibility with rcube_result_thread

Response

int

Number of elements

Reverts order of elements in the result

revert() 

Check if the given message ID exists in the object

exists(int $msgid, bool $get_index = false) : mixed

Arguments

$msgid

int

Message ID

$get_index

bool

When enabled element's index will be returned.

                   Elements are indexed starting with 0

Response

mixed

False if message ID doesn't exist, True if exists or

          index of the element if $get_index=true

Filters data set. Removes elements listed in $ids list.

filter(array $ids = array(), string $folder = null) 

Arguments

$ids

array

List of IDs to remove.

$folder

string

IMAP folder

Slices data set.

slice(mixed $offset, mixed $length) 

Arguments

$offset

mixed

Offset (as for PHP's array_slice())

$length

mixed

Number of elements (as for PHP's array_slice())

Filters data set. Removes elements not listed in $ids list.

intersect(array $ids = array()) 

Arguments

$ids

array

List of IDs to keep.

Return all messages in the result.

get() : array

Response

array

List of message IDs

Return all messages in the result.

get_compressed() : array

Response

array

List of message IDs

Return result element at specified index

get_element($idx) : int

Arguments

$idx

Response

int

Element value

Returns response parameters, e.g. ESEARCH's MIN/MAX/COUNT/ALL/MODSEQ or internal data e.g. MAILBOX, ORDER

get_parameters(string $param = null) : array|string

Arguments

$param

string

Parameter name

Response

array|string

Response parameters or parameter value

Returns the stored result object for a particular folder

get_set(string $folder) : false|\obejct

Arguments

$folder

string

Folder name

Response

false|\obejct

rcube_result_* instance of false if none found

Returns length of internal data representation

length() : int

Response

int

Data length

__sleep

__sleep() 

__wakeup

__wakeup() 

Properties

multi

multi : 

sets

sets : 

incomplete

incomplete : 

folder

folder : 

meta

meta : 

index

index : 

folders

folders : 

order

order : 

sorting

sorting :