Php/docs/function.imap-sort

提供:Dev Guides
< Php
移動先:案内検索

imap_sort

(PHP 4, PHP 5, PHP 7)

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


説明

imap_sort ( resource $imap_stream , int $criteria , int $reverse [, int $options = 0 [, string $search_criteria = null [, string $charset = null ]]] ) : array|false

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


パラメータ

imap_stream
imap_open() が返す IMAP ストリーム。
criteria
criteria は、次のどれかとします (ひとつのみ)。
  • SORTDATE - メッセージの日付
  • SORTARRIVAL - 到着日付
  • SORTFROM - 最初の From アドレスのメールボックス
  • SORTSUBJECT - メッセージ Subject
  • SORTTO - 最初の To アドレスのメールボックス
  • SORTCC - 最初の cc アドレスのメールボックス
  • SORTSIZE - メッセージのサイズ(バイト単位)
reverse
これを 1 にすると、逆順にソートします。
options
options はビットマスクで、以下の組み合わせとなります。
  • SE_UID - シーケンス番号の代わりに UID を返す
  • SE_NOPREFETCH - 検索したメッセージを事前取得しない
search_criteria
IMAP2 フォーマットの検索条件文字列。詳細は imap_search() を参照ください。
charset
文字列の検索の際に使う MIME 文字セット。


返り値

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