Edit Report a Bug

imap_status

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_status — Returns status information on a mailbox

Description

imap_status(IMAP\Connection $imap, string $mailbox, int $flags): stdClass|false

Gets status information about the given mailbox.

Parameters

imap

An IMAP\Connection instance.

mailbox

The mailbox name, see imap_open() for more information

Warning

Passing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.

flags

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, or false on failure. 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.

Changelog

Version	Description
8.1.0	The `imap` parameter expects an IMAP\Connection instance now; previously, a valid `imap` resource was expected.

Examples

Example #1 imap_status() 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 />\n";
  echo "Recent:     " . $status->recent      . "<br />\n";
  echo "Unseen:     " . $status->unseen      . "<br />\n";
  echo "UIDnext:    " . $status->uidnext     . "<br />\n";
  echo "UIDvalidity:" . $status->uidvalidity . "<br />\n";
} else {
  echo "imap_status failed: " . imap_last_error() . "\n";
}

imap_close($mbox);
?>

add a note

User Contributed Notes 3 notes

down

jille at DIESPAMMERShexon dot cx ¶

17 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..

Conclusion:
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

down

mwwaygoo AT hotmail DOT com ¶

12 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.

<?php
    function my_imap_status($stream, $mailbox='', $info=SA_ALL)
    {
        // get current mailbox name (and info)
        $curr_obj=imap_check($stream);
        if(!$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
        $current_mailbox=$curr_obj->Mailbox;
        
        //switch to new mailbox
        if(!imap_reopen($stream, $mailbox)) return false;
        
        // get info
        $obj=imap_check($stream);
        
        // switch back to original mailbox
        imap_reopen($stream, $current_mailbox);
        
        //return info
        return $obj;
    }
?>

down

-2

razonklnbd at hotmail dot com ¶

16 years ago


another tips is to get only total number of message and recent message

$imap_obj = imap_status($mbox, '{mail.mysrv.com:143/imap}INBOX', SA_MESSAGES+SA_RECENT);
echo('<pre>'); var_dump($imap_obj); echo('</pre>');

add a note