(PHP 4, PHP 5, PHP 7, PHP 8)
imap_sort — Gets and sort messages
$imap,$criteria,$reverse,$flags = 0,$search_criteria = null,$charset = nullGets and sorts message numbers by the given parameters.
imapAn IMAP\Connection instance.
criteriaCriteria can be one (and only one) of the following:
SORTDATE - message Date
SORTARRIVAL - arrival date
SORTFROM - mailbox in first From address
SORTSUBJECT - message subject
SORTTO - mailbox in first To address
SORTCC - mailbox in first cc address
SORTSIZE - size of message in octets
reverseWhether to sort in reverse order.
flags
The flags are a bitmask of one or more of the
following:
SE_UID - Return UIDs instead of sequence numbers
SE_NOPREFETCH - Don't prefetch searched messages
search_criteriaIMAP2-format search criteria string. For details see imap_search().
charsetMIME character set to use when sorting strings.
Returns an array of message numbers sorted by the given
parameters, or false on failure.
| Version | Description |
|---|---|
| 8.1.0 |
The imap parameter expects an IMAP\Connection
instance now; previously, a valid imap resource was expected.
|
| 8.0.0 |
reverse is now bool instead of int.
|
| 8.0.0 |
search_criteria and charset are now nullable.
|