(3.0.4 - 3.0.18 only, PHP 4 >= 4.0.0)

imap_status --  This function returns status information on a mailbox other than the current one


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

This function returns an object containing status information. Valid flags are:

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

Example 1. imap_status() example

$mbox = imap_open("{}","username","password",OP_HALFOPEN)
      or die("can't connect: ".imap_last_error());
$status = imap_status($mbox,"{}INBOX",SA_ALL);
if($status) {
  print("Messages:   ". $status->messages   )."<br>\n";
  print("Recent:     ". $status->recent     )."<br>\n";
  print("Unseen:     ". $status->unseen     )."<br>\n";
  print("UIDnext:    ". $status->uidnext    )."<br>\n";
  print("UIDvalidity:". $status->uidvalidity)."<br>\n"; 
} else
  print "imap_status failed: ".imap_last_error()."\n";