JavaScript Editor Javascript debugger     Website design 


Check current mailbox (PHP 4, PHP 5)
object imap_check ( resource imap_stream )

Checks information about the current mailbox.



An IMAP stream returned by imap_open().

Return Values

Returns the information in an object with following properties:

  • Date - current system time formatted according to » RFC2822
  • Driver - protocol used to access this mailbox: POP3, IMAP, NNTP
  • Mailbox - the mailbox name
  • Nmsgs - number of messages in the mailbox
  • Recent - number of recent messages in the mailbox

Returns FALSE on failure.


Example 1045. imap_check() example


= imap_check($imap_stream);


The above example will output something similar to:

object(stdClass)(5) {
 string(37) "Wed, 10 Dec 2003 17:56:54 +0100 (CET)"
 string(4) "imap"