imap_status
Gets status information about the given mailbox.
Parameters
- imap
An IMAP\Connection instance.
- mailbox
-
The mailbox name, see imap_open for more information
Warning:
Passing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.
- flags
-
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
Return Values
This function returns an object containing status information, or false on failure. 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.
Changelog
| Version | Description |
| 8.1.0 | The imap parameter expects an IMAP\Connection instance now; previously, a resource was expected. |