imap_check

(PHP 4, PHP 5)

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

説明

object imap_check ( resource $imap_stream )

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

パラメータ

imap_stream

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

返り値

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

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

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

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

add a note add a note

User Contributed Notes 4 notes

up
4
Anonymous
9 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
2
rasmus at flajm dot com
10 years ago
Running this on a mailbox will mark recent/new messages as checked.
up
1
erik at phpcastle dot com
8 years ago
The imap_check ($stream); function will return real-time information about the e-mail box (at least imap) during one connection :)
up
0
JUNIOR TELLO
8 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.
To Top