Edit Report a Bug

    imap_check

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

    imap_check — 現在のメールボックスをチェックする

    説明

    imap_check(IMAP\Connection $imap): stdClass|false

    現在のメールボックスに関する情報を調べます。

    パラメータ

    imap

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

    戻り値

    以下のプロパティをもつオブジェクトの情報を返します。

    • Date - 現在のシステム時刻を » RFC2822 にしたがってフォーマットしたもの。
    • Driver - メールボックスにアクセスする際に使用するプロトコル: POP3、IMAP、NNTP
    • Mailbox - メールボックスの名前。
    • Nmsgs - メールボックス内のメッセージの数。
    • Recent - メールボックス内の新規メッセージの数。

    失敗した場合には false を返します。

    変更履歴

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

    例

    例1 imap_check() の例

    <?php

    $imap     = imap_check($imap_stream);
    var_dump($imap);

    ?>

    上の例の出力は、 たとえば以下のようになります。

    object(stdClass)(5) {
  ["Date"]=>
  string(37) "Wed, 10 Dec 2003 17:56:54 +0100 (CET)"
  ["Driver"]=>
  string(4) "imap"
  ["Mailbox"]=>
  string(54)
  "{www.example.com:143/imap/user="foo@example.com"}INBOX"
  ["Nmsgs"]=>
  int(1)
  ["Recent"]=>
  int(0)
}

    add a note add a note

    User Contributed Notes 4 notes

    up
    3
    erik at phpcastle dot com
    18 years ago
    The imap_check ($stream); function will return real-time information about the e-mail box (at least imap) during one connection :)
    up
    3
    Anonymous
    20 years ago
    You can prevent imap_check from flagging new/recent messages as checked by calling imap_open with the "/readonly" or OP_READONLY flags.
    up
    -1
    JUNIOR TELLO
    18 years ago
    You can NOT prevent imap_check from flagging new/recent messages when using POP3 enabling the "/readonly" or OP_READONLY flags or options.
    up
    -1
    rasmus at flajm dot com
    20 years ago
    Running this on a mailbox will mark recent/new messages as checked.
    add a note add a note
    To Top