imap_status

Returns status information on a mailbox

&reftitle.description; ``stdClass``false```imap_status` `IMAP\Connection` `imap` `string` `mailbox` `int` `flags`

Gets status information about the given `mailbox`.

&reftitle.parameters;

&imap.imap-parameter.imap;

`mailbox`

- The mailbox name, see `imap_open` for more information

  &imap.mailboxname.insecure;

`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

&reftitle.returnvalues;

This function returns an object containing status information, &return.falseforfailure;. 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.

&reftitle.changelog;

&Version; | &Description;
&imap.changelog.imap-param;

&reftitle.examples;

### `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);
    ?>