php man page for imap_check

IMAP_CHECK(3)								 1							     IMAP_CHECK(3)

imap_check - Check current mailbox

SYNOPSIS
       object imap_check (resource  $imap_stream)

DESCRIPTION
	Checks information about the current mailbox.

PARAMETERS
	      o $
		imap_stream -An IMAP stream returned by imap_open(3).

RETURN VALUES
	Returns the information in an object with following properties:

	      o Date - current system time formatted according to RFC2822

	      o Driver - protocol used to access this mailbox: POP3, IMAP, NNTP

	      o Mailbox - the mailbox name

	      o Nmsgs - number of messages in the mailbox

	      o Recent - number of recent messages in the mailbox

	Returns FALSE on failure.

EXAMPLES
       Example #1

	      imap_check(3) example

	      <?php

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

	      ?>

	      The above example will output something similar to:

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

PHP Documentation Group 													     IMAP_CHECK(3)