IMAP_STATUS(3)								 1							    IMAP_STATUS(3)

imap_status - Returns status information on a mailbox

SYNOPSIS

       object imap_status (resource  $imap_stream, string  $mailbox, int  $options)

DESCRIPTION

	Gets status information about the given $mailbox.

PARAMETERS

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

	      o $mailbox
		- The mailbox name, see imap_open(3) for more information

	      o $options
		- Valid flags are:

		     o SA_MESSAGES - set $status->messages to the number of messages in the mailbox

		     o SA_RECENT - set $status->recent to the number of recent messages in the mailbox

		     o SA_UNSEEN - set $status->unseen to the number of unseen (new) messages in the mailbox

		     o SA_UIDNEXT - set $status->uidnext to the next uid to be used in the mailbox

		     o SA_UIDVALIDITY - set $status->uidvalidity to a constant that changes when uids for the mailbox may no longer be valid

		     o SA_ALL - set all of the above

RETURN VALUES

	This function returns an object containing status information. The object has the following properties: messages, recent, unseen, uidnext,
       and uidvalidity.

       flags is also set, which contains a bitmask which can be checked against any of the above constants.

EXAMPLES

       Example #1

	      imap_status(3) example

	      <?php
	      $mbox = imap_open("{imap.example.com}", "username", "password", OP_HALFOPEN)
		    or die("can't connect: " . imap_last_error());

	      $status = imap_status($mbox, "{imap.example.org}INBOX", SA_ALL);
	      if ($status) {
		echo "Messages:   " . $status->messages    . "<br />
";
		echo "Recent:	  " . $status->recent	   . "<br />
";
		echo "Unseen:	  " . $status->unseen	   . "<br />
";
		echo "UIDnext:	  " . $status->uidnext	   . "<br />
";
		echo "UIDvalidity:" . $status->uidvalidity . "<br />
";
	      } else {
		echo "imap_status failed: " . imap_last_error() . "
";
	      }

	      imap_close($mbox);
	      ?>

PHP Documentation Group 													    IMAP_STATUS(3)