Roundcube Framework
Back to top  

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

__sleep

__sleep()

__wakeup

__wakeup()

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

Returns number of elements in the result

count() : integer

Response

integer

Number of elements

Returns number of elements in the result.

count_messages() : integer

Alias for count() for compatibility with rcube_result_thread

Response

integer

Number of elements

Check if the given message ID exists in the object

exists(integer $msgid, boolean $get_index = false) : mixed

Arguments

$msgid

integer

Message ID

$get_index

boolean

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

Return all messages in the result.

get() : array

Response

array

List of message IDs

Return all messages in the result in compressed form

get_compressed() : string

Response

string

List of message IDs in compressed form

Return result element at specified index

get_element( $idx) : integer

Arguments

$idx

Response

integer

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|object

Arguments

$folder

string

Folder name

Response

false|object

rcuberesult* instance of false if none found

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

intersect(array $ids = array())

Arguments

$ids

array

List of IDs to keep.

Checks if the result is empty

is_empty() : boolean

Response

boolean

True if the result is empty, False otherwise

Checks the result from IMAP command

is_error() : boolean

Response

boolean

True if the result is an error, False otherwise

Returns length of internal data representation

length() : integer

Response

integer

Data length

Reverts order of elements in the result

revert()

Store a global index of (sorted) message UIDs

set_message_index( $headers,  $sort_field,  $sort_order)

Arguments

$headers

$sort_field

$sort_order

Slices data set.

slice(integer $offset, integer $length)

Arguments

$offset

integer

Offset (as for PHP's array_slice())

$length

integer

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

Properties

multi

multi :

Type(s)

sets

sets :

Type(s)

incomplete

incomplete :

Type(s)

folder

folder :

Type(s)

meta

meta :

Type(s)

index

index :

Type(s)

folders

folders :

Type(s)

sdata

sdata :

Type(s)

order

order :

Type(s)

sorting

sorting :

Type(s)