imap_check

(PHP 4, PHP 5)

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

説明

object imap_check ( resource $imap_stream )

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

パラメータ

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

返り値

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

Date - 現在のシステム時刻を » RFC2822 にしたがってフォーマットしたもの。
Driver - メールボックスにアクセスする際に使用するプロトコル: POP3、IMAP、NNTP
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)
}

imap_clearflag_full

imap_bodystruct

Last updated: Fri, 05 Sep 2008

add a note User Contributed Notes
imap_check

JUNIOR TELLO
27-Jan-2006 11:43


You can NOT prevent imap_check from flagging new/recent messages when using POP3 enabling the "/readonly" or OP_READONLY flags or options.

erik at phpcastle dot com
14-Dec-2005 12:49


The imap_check ($stream); function will return real-time information about the e-mail box (at least imap) during one connection :)

29-Oct-2004 04:21


You can prevent imap_check from flagging new/recent messages as checked by calling imap_open with the "/readonly" or OP_READONLY flags.

rasmus at flajm dot com
19-Dec-2003 01:06


Running this on a mailbox will mark recent/new messages as checked.

add a note

imap_clearflag_full

imap_bodystruct

Last updated: Fri, 05 Sep 2008