IMAP 関数
PHP Manual

imap_fetch_overview

(PHP 4, PHP 5, PHP 7)

imap_fetch_overview指定したメッセージのヘッダ情報の概要を読む

説明

array imap_fetch_overview ( resource $imap_stream , string $sequence [, int $options = 0 ] )

この関数は、指定された sequence のメールヘッダを取得してその内容の概要を返します。

パラメータ

imap_stream

imap_open() が返す IMAP ストリーム。

sequence

メッセージのシーケンスを指定します。 X,Y 形式で列挙したり、 X:Y 形式でその範囲内のすべてのメッセージを取得したりできます。

options

sequence には、メッセージのインデックスか、もし flags に FT_UID が含まれている場合は UID が含まれます。

返り値

オブジェクトの配列を返します。各要素が、 それぞれひとつのメッセージのヘッダを表します。 オブジェクトで定義されるのは、存在するプロパティのみです。 以下のプロパティがあります。

変更履歴

バージョン 説明
PHP 5.3.3 update プロパティが追加されました。

例1 imap_fetch_overview() の例

<?php
$mbox 
imap_open("{imap.example.org:143}INBOX""username""password")
     or die(
"接続できません: " imap_last_error());

$MC imap_check($mbox);

// INBOX のすべてのメッセージの概要を取得します
$result imap_fetch_overview($mbox,"1:{$MC->Nmsgs}",0);
foreach (
$result as $overview) {
    echo 
"#{$overview->msgno} ({$overview->date}) - From: {$overview->from}
    
{$overview->subject}\n";
}
imap_close($mbox);
?>

参考


IMAP 関数
PHP Manual