imap_check

(PHP 3, PHP 4, PHP 5)

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

説明

object imap_check ( resource imap_stream )

現在のメールボックスに関する情報を返します。失敗した場合は FALSE を返します。

imap_check() 関数は、サーバ上の現在のメールボックスの ステータスをチェックし、その情報を以下のプロパティを有するオブジェクト として返します。

例 1. imap_check() の例

<?php

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

?>

この出力は以下のようになります。

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