Home > PHP > Function > IMAP > imap_status()

imap_status()

imap_status - Returns status information on a mailbox

Syntax

object imap_status (resource $imap_stream, string $mailbox, int $options)

Arguments

  • imap_stream - An IMAP stream returned by imap_open().
  • mailbox - The mailbox name, see imap_open() for more information
  • options - Valid flags are: SA_MESSAGES - set ->messages to the number of messages in the mailbox SA_RECENT - set ->recent to the number of recent messages in the mailbox SA_UNSEEN - set ->unseen to the number of unseen (new) messages in the mailbox SA_UIDNEXT - set ->uidnext to the next uid to be used in the mailbox SA_UIDVALIDITY - set ->uidvalidity to a constant that changes when uids for the mailbox may no longer be valid SA_ALL - set all of the above

Description

Gets status information about the given mailbox.

Version

PHP 4, 5

Return value

This function returns an object containing status information. The object has the following properties: messages, recent, unseen, uidnext, and uidvalidity.