(PHP 4, PHP 5)
imap_search — 指定した検索条件にマッチするメッセージを配列として返す
$imap_stream
, string $criteria
[, int $options = SE_FREE
[, string $charset = NIL
]] )この関数は、指定した IMAP ストリームの現在オープンしているメールボックス において検索を行います。
例えば、Mom から送られた全ての未回答のメッセージにマッチさせるには、 "UNANSWERED FROM mom" を使用します。 検索は、大文字小文字が区別されずに行われます。 検索条件のリストは、UW c-client のソースコードからのものであり、 不完全または不正確である可能性があります (» RFC2060, section 6.4.4 も参照ください)。
imap_streamimap_open() が返す IMAP ストリーム。
criteria
空白で区切られた文字列で、以下のキーワードが使用可能です。
複数の単語からなるキーワード（例 FROM "joey smith"）
は全て引用符で括る必要があります。
結果は、すべての criteria エントリにマッチすることになります。
options
options に指定できる値は
SE_UID です。これを指定すると、
メッセージ番号ではなく UID を含む配列を返します。
charset
メッセージ番号あるいは UID の配列を返します。
検索条件 criteria を処理できなかった場合や
結果が見つからなかった場合は、FALSE を返します。
| バージョン | 説明 |
|---|---|
| 4.3.3 |
パラメータ charset が追加されました。
|
例1 imap_search() の例
<?php
$conn = imap_open('{imap.example.com:993/imap/ssl}INBOX', '[email protected]', 'pass123', OP_READONLY);
$some = imap_search($conn, 'SUBJECT "HOWTO be Awesome" SINCE "8 August 2008"', SE_UID);
$msgnos = imap_search($conn, 'ALL');
$uids = imap_search($conn, 'ALL', SE_UID);
print_r($some);
print_r($msgnos);
print_r($uids);
?>
上の例の出力は、 たとえば以下のようになります。
Array
(
[0] => 4
[1] => 6
[2] => 11
)
Array
(
[0] => 1
[1] => 2
[2] => 3
[3] => 4
[4] => 5
[5] => 6
)
Array
(
[0] => 1
[1] => 4
[2] => 6
[3] => 8
[4] => 11
[5] => 12
)