(PHP 4, PHP 5, PHP 7)

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

Значення, що повертаються

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.


Приклад #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";


add a note add a note

User Contributed Notes 3 notes

jille at DIESPAMMERShexon dot cx
16 years ago
In 'reply' to my previous post;
I`m not sure of that anymore
I think this trick works,
but the rest of my script just sucks..

You can get the last UID by using status->uidnext-1
BUT: This is not a good way, if another message is added after your append and before your status; you are screwed
mwwaygoo AT hotmail DOT com
11 years ago
I had issues with imap_status not working correctly, while other imap functions seemed okay. I always got the ['flags']=0 response. No notes here and Google searching suggests it doesn't working properly with Exchange, so I wrote a little workaround, to at least get some information.

function my_imap_status($stream, $mailbox='', $info=SA_ALL)
// get current mailbox name (and info)
$curr_obj) return false;
// if request if for current mailbox then just return it
if( (empty($mailbox)) || ($mailbox==$curr_obj->Mailbox) ) return $curr_obj;
// get current mailbox
//switch to new mailbox
if(!imap_reopen($stream, $mailbox)) return false;
// get info
// switch back to original mailbox
imap_reopen($stream, $current_mailbox);
//return info
return $obj;
razonklnbd at hotmail dot com
15 years ago
another tips is to get only total number of message and recent message

$imap_obj = imap_status($mbox, '{}INBOX', SA_MESSAGES+SA_RECENT);
echo('<pre>'); var_dump($imap_obj); echo('</pre>');
To Top