Class for accessing IMAP's SORT/SEARCH/ESEARCH result
package |
Framework |
---|---|
subpackage |
Storage |
__construct($mailbox = null, $data = null)
init(string $data = null)
string
IMAP response string
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
max() : int
int
Maximal message identifier
min() : int
int
Minimal message identifier
slice(mixed $offset, mixed $length)
mixed
Offset (as for PHP's array_slice())
mixed
Number of elements (as for PHP's array_slice())
filter(array $ids = array())
array
List of IDs to remove.
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
get() : array
array
List of message IDs
get_compressed() : array
array
List of message IDs
get_element(int|string $index) : int
int|string
Element's index or "FIRST" or "LAST"
int
Element value
get_parameters(string $param = null) : array|string
string
Parameter name
array|string
Response parameters or parameter value
length() : int
int
Data length
SEPARATOR_ELEMENT
raw_data :
mailbox :
params :
order :