imap_mailboxmsginfo
PHP 4, PHP 5, PHP 7, PHP 8
imap_mailboxmsginfo - Get information about the current mailbox
Manual
imap_mailboxmsginfo(
IMAP\Connection$imap ): stdClass
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.
Parameters
- imap
An IMAP\Connection instance.
Return Values
Returns the information in an object with following 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 |
Returns false on failure.
Changelog
| Version | Description |
| 8.1.0 | The imap parameter expects an IMAP\Connection instance now; previously, a resource was expected. |