imap_mailboxmsginfo()

imap_mailboxmsginfo - Get information about the current mailbox

Syntax

object imap_mailboxmsginfo (resource $imap_stream)

Arguments

• imap_stream - An IMAP stream returned by imap_open().

Description

Checks the current mailbox status on the server. It is similar to imap_status(), but will additionally sum up the size of all messages in the mailbox, which will take some additional time to execute.

Version

PHP 4, 5

Return value

Returns the information in an object with following properties: Mailbox properties Date date of last change (current datetime) Driver driver Mailbox name of the mailbox Nmsgs number of messages Recent number of recent messages Unread number of unread messages Deleted number of deleted messages Size mailbox size