imap_check
Name
imap_check — Check the current mailbox
Synopsis
object imap_check
(connection);
int connection: IMAP
connection ID
Returns
Mailbox information; FALSE on error
Description
Returns an array containing useful information about the
IMAP mailbox. The function returns FALSE if there are no
new messages. The object properties returned are:
Version
Since versions 3.0 and 4.0
See also
See also: imap_status
Example
Example 596. Get number of
messages in mailbox
<?php
$imap = imap_open("{localhost}INBOX","graeme","inferno");
$info = imap_check($imap);
echo "Number of messages: ", $info->Nmsgs;
imap_close($imap);
?>
Output:
Number of messages: 6
PHP Functions Essential Reference. Copyright © 2002 by New Riders Publishing
(Authors: Zak Greant, Graeme Merrall, Torben Wilson, Brett Michlitsch).
This material may be distributed only subject to the terms and conditions set forth
in the Open Publication License, v1.0 or later (the latest version is presently available at
http://www.opencontent.org/openpub/).
The authors of this book have elected not to choose any options under the OPL. This online book was obtained
from
http://www.fooassociates.com/phpfer/
and is designed to provide information about the PHP programming language, focusing on PHP version 4.0.4
for the most part. The information is provided on an as-is basis, and no warranty or fitness is implied. All
persons and entities shall have neither liability nor responsibility to any person or entity with respect to
any loss or damage arising from the information contained in this book.