imap_check
PHP function
Edit on GitHub ✎
(PHP 4, PHP 5, PHP 7, PHP 8)
Check current mailbox
Description
imap_check(IMAP\Connection $imap): stdClass|false
Checks information about the current mailbox.
Parameters
Return Values
Returns the information in an object with following properties:
Date- current system time formatted according to RFC2822Driver- protocol used to access this mailbox: POP3, IMAP, NNTPMailbox- the mailbox nameNmsgs- number of messages in the mailboxRecent- number of recent messages in the mailbox
Returns false on failure.
Changelog
| Version | Description |
|---|
Examples
imap_check() example
php
<?php
$imap = imap_check($imap_stream);
var_dump($imap);
?>The above example will output something similar to:
output
object(stdClass)(5) {
["Date"]=>
string(37) "Wed, 10 Dec 2003 17:56:54 +0100 (CET)"
["Driver"]=>
string(4) "imap"
["Mailbox"]=>
string(54)
"{www.example.com:143/imap/user="foo@example.com"}INBOX"
["Nmsgs"]=>
int(1)
["Recent"]=>
int(0)
}