imap_search

説明

array imap_search ( resource imap_stream, string criteria [, int options [, string charset]] )

この関数は、指定した imap ストリームの現在オープンしているメールボックス において検索を行います。criteria は空白で区切られた文字列で、以下のキーワードが使用可能です。 複数の単語からなるキーワード（例 FROM "joe smith"）は全て引用符で括る 必要があります。

• ALL - 他の検索条件にマッチする全メッセージを返す

• ANSWERED - \\ANSWERED フラグが設定されているメッセージにマッチ

• BCC "string" - Bcc: フィールドに "string" を有するメッセージにマッチ

• BEFORE "date" - "date" より前の Date: を有するメッセージにマッチ

• BODY "string" - メッセージ本体に "string" を有するメッセージにマッチ

• CC "string" - Cc: フィールドに "string" を有するメッセージにマッチ

• DELETED - 削除されたメッセージにマッチ

• FLAGGED - \\FLAGGED フラグ（重要または緊急を表すものとして 使用されることがあります）が設定されているメッセージにマッチ

• FROM "string" - From: フィールドに "string" を有するメッセージにマッチ

• KEYWORD "string" - キーワードとして "string" を有するメッセージにマッチ

• NEW - 新規メッセージにマッチ

• OLD - 古いメッセージにマッチ

• ON "date" - Date: が "date" であるメッセージにマッチ

• RECENT - \\RECENT フラグが設定されているメッセージにマッチ

• SEEN - 既読の（\\SEEN フラグが設定されている）メッセージにマッチ

• SINCE "date" - Date: が "date" 以降であるメッセージにマッチ

• SUBJECT "string" - Subject: に "string" を有するメッセージにマッチ

• TEXT "string" - テキスト "string" を有するメッセージにマッチ

• TO "string" - To: に "string" を有するメッセージにマッチ

• UNANSWERED - 未回答のメッセージにマッチ

• UNDELETED - 削除されていないメッセージにマッチ

• UNFLAGGED - フラグが設定されていないメッセージにマッチ

• UNKEYWORD "string" - キーワード "string" を有さないメッセージにマッチ

• UNSEEN - 未読のメッセージにマッチ

例えば、Mom から送られた全ての未回答のメッセージにマッチさせるには、 "UNANSWERED FROM mom" を使用します。 検索は、大文字小文字が区別されずに行われます。 検索条件のリストは、UW C クライアントのソースコードからのものであり、 不完全または不正確である可能性があります (RFC2060, section 6.4.4 も参照ください)。

SE_UID が有効なフラグとして設定されている場合、 メッセージ番号の変わりに UID を有する配列が返されます。

パラメータ charset は PHP 4.3.3 で追加されました。