The imap_check ($stream); function will return real-time information about the e-mail box (at least imap) during one connection :)
imap_check
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_check — Check current mailbox
Description
Checks information about the current mailbox.
Return Values
Returns the information in an object with following properties:
-
Date- current system time formatted according to » RFC2822 -
Driver- protocol used to access this mailbox: POP3, IMAP, NNTP -
Mailbox- the mailbox name -
Nmsgs- number of messages in the mailbox -
Recent- number of recent messages in the mailbox
Returns false on failure.
Changelog
| Version | Description |
|---|---|
| 8.1.0 |
The imap parameter expects an IMAP\Connection
instance now; previously, a valid imap resource was expected.
|
Examples
Example #1 imap_check() example
<?php
$imap = imap_check($imap_stream);
var_dump($imap);
?>The above example will output something similar to:
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)
}
add a note
User Contributed Notes 4 notes
erik at phpcastle dot com ¶
18 years ago
Anonymous ¶
20 years ago
You can prevent imap_check from flagging new/recent messages as checked by calling imap_open with the "/readonly" or OP_READONLY flags.
JUNIOR TELLO ¶
18 years ago
You can NOT prevent imap_check from flagging new/recent messages when using POP3 enabling the "/readonly" or OP_READONLY flags or options.
rasmus at flajm dot com ¶
20 years ago
Running this on a mailbox will mark recent/new messages as checked.
