imap_status
Returns status information on a mailbox
&reftitle.description;
objectimap_status
resourceimap_stream
stringmailbox
intoptions
Gets status information about the given mailbox.
&reftitle.parameters;
&imap.imap-stream.description;
mailbox
The mailbox name, see imap_open for more
information
options
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.
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.examples;
<function>imap_status</function> example
messages . "
\n";
echo "Recent: " . $status->recent . "
\n";
echo "Unseen: " . $status->unseen . "
\n";
echo "UIDnext: " . $status->uidnext . "
\n";
echo "UIDvalidity:" . $status->uidvalidity . "
\n";
} else {
echo "imap_status failed: " . imap_last_error() . "\n";
}
imap_close($mbox);
?>
]]>