PYTHON imap_status

is this article helpful?
Python replacement for PHP's imap_status [ edit | history ]
imapobj.status(mailbox, option_names)

PHP imap_status

PHP original manual for imap_status [ show | ]


(PHP 4, PHP 5)

imap_statusReturns status information on a mailbox


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

Gets status information about the given mailbox .



An IMAP stream returned by imap_open().


The mailbox name, see imap_open() for more information


Valid flags are:

  • SA_MESSAGES - set status->messages to the number of messages in the mailbox
  • SA_RECENT - set status->recent to the number of recent messages in the mailbox
  • SA_UNSEEN - set status->unseen to the number of unseen (new) messages in the mailbox
  • SA_UIDNEXT - set status->uidnext to the next uid to be used in the mailbox
  • SA_UIDVALIDITY - set status->uidvalidity to a constant that changes when uids for the mailbox may no longer be valid
  • 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.


Example #1 imap_status() example

      or die(
"can't connect: " imap_last_error());

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