PHPのお勉強！

PHP TOP
PHP 8.4.2 Released!

    imap_fetch_overview

    (PHP 4, PHP 5, PHP 7, PHP 8)

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

    説明

    imap_fetch_overview(IMAP\Connection $imap, string $sequence, int $flags = 0): array|false

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

    パラメータ

    imap

    IMAP\Connection クラスのインスタンス。

    sequence

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

    flags

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

    戻り値

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

    • subject - メッセージの題名(subject)
    • from - 送信者
    • to - 受信者
    • date - 送信日
    • message_id - Message-ID
    • references - このメッセージ ID への参照です
    • in_reply_to - このメッセージ ID への返信です
    • size - サイズ（バイト数）
    • uid - メールボックスにおけるこのメッセージの UID
    • msgno - メールボックスにおけるこのメッセージのシーケンス番号
    • recent - このメッセージには recent フラグが立てられています
    • flagged - フラグが立てられています
    • answered - 返信済みフラグが立てられています
    • deleted - 削除フラグが立てられています
    • seen - 既読フラグが立てられています
    • draft - 草稿フラグが立てられています
    • udate - 受信日時の UNIX タイムスタンプ
    この関数は、失敗した時に false を返します。

    変更履歴

    バージョン 説明
    8.1.0 引数 imap は、IMAP\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、有効な imap リソース が期待されていました。

    例

    例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);
    ?>

    参考

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes

    There are no user contributed notes for this page.