Class holding a set of rcube_result_index instances that together form a result set of a multi-folder search
package |
Framework |
---|---|
subpackage |
Storage |
__construct($folders = array())
add($result)
append_result($result)
is_error() : bool
bool
True if the result is an error, False otherwise
is_empty() : bool
bool
True if the result is empty, False otherwise
count() : int
int
Number of elements
revert()
exists(int $msgid, bool $get_index = false) : mixed
int
Message ID
bool
When enabled element's index will be returned.
Elements are indexed starting with 0
mixed
False if message ID doesn't exist, True if exists or
index of the element if $get_index=true
filter(array $ids = array(), string $folder = null)
array
List of IDs to remove.
string
IMAP folder
slice(mixed $offset, mixed $length)
mixed
Offset (as for PHP's array_slice())
mixed
Number of elements (as for PHP's array_slice())
intersect(array $ids = array())
array
List of IDs to keep.
get() : array
array
List of message IDs
get_compressed() : array
array
List of message IDs
get_element($idx) : int
int
Element value
get_parameters(string $param = null) : array|string
string
Parameter name
array|string
Response parameters or parameter value
get_set(string $folder) : false|\obejct
string
Folder name
false|\obejct
rcube_result_* instance of false if none found
length() : int
int
Data length
__sleep()
__wakeup()
multi :
sets :
incomplete :
folder :
index :
folders :
order :
sorting :