PHP マニュアル: 現在のメールボックスをチェックする

説明

stdClassfalse imap_check(IMAP\Connection $imap)

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

パラメータ

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)
}