IMAP_MAILBOXMSGINFO(3) 1 IMAP_MAILBOXMSGINFO(3)
imap_mailboxmsginfo - Get information about the current mailbox
SYNOPSIS
object imap_mailboxmsginfo (resource $imap_stream)
DESCRIPTION
Checks the current mailbox status on the server. It is similar to imap_status(3), but will additionally sum up the size of all messages in
the mailbox, which will take some additional time to execute.
PARAMETERS
o $
imap_stream -An IMAP stream returned by imap_open(3).
RETURN VALUES
Returns the information in an object with following properties:
Mailbox 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.
EXAMPLES
Example #1
imap_mailboxmsginfo(3) example
<?php
$mbox = imap_open("{imap.example.org}INBOX", "username", "password")
or die("can't connect: " . imap_last_error());
$check = imap_mailboxmsginfo($mbox);
if ($check) {
echo "Date: " . $check->Date . "<br />
" ;
echo "Driver: " . $check->Driver . "<br />
" ;
echo "Mailbox: " . $check->Mailbox . "<br />
" ;
echo "Messages: " . $check->Nmsgs . "<br />
" ;
echo "Recent: " . $check->Recent . "<br />
" ;
echo "Unread: " . $check->Unread . "<br />
" ;
echo "Deleted: " . $check->Deleted . "<br />
" ;
echo "Size: " . $check->Size . "<br />
" ;
} else {
echo "imap_mailboxmsginfo() failed: " . imap_last_error() . "<br />
";
}
imap_close($mbox);
?>
PHP Documentation Group IMAP_MAILBOXMSGINFO(3)
