imap_sort

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_sortGets and sort messages

说明

imap_sort(
    IMAP\Connection $imap,
    int $criteria,
    bool $reverse,
    int $flags = 0,
    ?string $search_criteria = null,
    ?string $charset = null
): array|false

Gets and sorts message numbers by the given parameters.

参数

imap

IMAP\Connection 实例。

criteria

Criteria can be one (and only one) of the following:

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, 或者在失败时返回 false.

更新日志

版本 说明
8.1.0 现在 imap 参数接受 IMAP\Connection 实例,之前接受有效的 imap resource
8.0.0 reverse is now bool instead of int.
8.0.0 search_criteria and charset are now nullable.
add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top