imap_sort
メッセージヘッダの配列をソートする
説明
arrayfalse imap_sort(
IMAP\Connection $imap,
int $criteria,
bool $reverse,
int $flags = 0,
stringnull $search_criteria = null,
stringnull $charset = null
)
パラメータ
-
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 を返します