imap_sort

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

imap_sort — メッセージヘッダの配列をソートする

説明

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

指定したパラメータにより取得したメッセージ番号をソートします。

パラメータ

imap

IMAP\Connection クラスのインスタンス。

criteria

criteria は、次のどれかとします (ひとつのみ)。

  • SORTDATE - メッセージの日付
  • SORTARRIVAL - 到着日付
  • SORTFROM - 最初の From アドレスのメールボックス
  • SORTSUBJECT - メッセージ Subject
  • SORTTO - 最初の To アドレスのメールボックス
  • SORTCC - 最初の cc アドレスのメールボックス
  • SORTSIZE - メッセージのサイズ（バイト単位）

reverse

逆順にソートするかどうかを指定します。

flags

flags はビットマスクで、以下の組み合わせとなります。

  • SE_UID - シーケンス番号の代わりに UID を返す
  • SE_NOPREFETCH - 検索したメッセージを事前取得しない

search_criteria

IMAP2 フォーマットの検索条件文字列。詳細は imap_search() を参照ください。

charset

文字列の検索の際に使う MIME 文字セット。

戻り値

指定したパラメータでソートしたメッセージ番号の配列を返します。 失敗した場合に false を返します

変更履歴

バージョン 説明
8.1.0 引数 imap は、IMAP\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、リソース が期待されていました。
8.0.0 reverse の型が、int から bool に変更されました。
8.0.0 search_criteria, charset は、 nullable になりました。
関連キーワード: 　メッセージ, ソート, 配列, ヘッダ, criteria, search, 検索, メールボックス, 最初, 番号