PHP Manual
Prev |  | Next

# imap_status

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

## Description

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

This function returns an object containing status 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

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

Prev | Home | Next
imap_alerts | Up | imap_utf7_decode