array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'function.imap-sort.php', 1 => 'imap_sort', ), 'up' => array ( 0 => 'ref.imap.php', 1 => 'IMAP Functions', ), 'prev' => array ( 0 => 'function.imap-setflag-full.php', 1 => 'imap_setflag_full', ), 'next' => array ( 0 => 'function.imap-status.php', 1 => 'imap_status', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/imap/functions/imap-sort.xml', ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); ?>
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_sort — Gets and sort messages
$imap
,$criteria
,$reverse
,$flags
= 0,$search_criteria
= null
,$charset
= null
Gets and sorts message numbers by the given parameters.
imap
An IMAP\Connection instance.
criteria
Criteria 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
reverse
Whether 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_criteria
IMAP2-format search criteria string. For details see imap_search().
charset
MIME 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.
|