imap_mailboxmsginfo

(PHP 3 >= 3.0.2, PHP 4, PHP 5)

imap_mailboxmsginfo -- Get information about the current mailbox

Descrição

object imap_mailboxmsginfo ( resource imap_stream )

Checks the current mailbox status on the server. It is similar to imap_status(), but will additionally sum up the size of all messages in the mailbox, which will take some additional time to execute.

Parâmetros

imap_stream

Um stream IMAP retornado por imap_open().

Valores de retornado

Returns the information in an object with following properties:

Tabela 1. Mailbox properties

Datedate of last change
Driverdriver
Mailboxname of the mailbox
Nmsgsnumber of messages
Recentnumber of recent messages
Unreadnumber of unread messages
Deletednumber of deleted messages
Sizemailbox size

Returns FALSE on failure.

Exemplos

Exemplo 1. imap_mailboxmsginfo() 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 />\n" ;
    echo
"Driver: "   . $check->Driver  . "<br />\n" ;
    echo
"Mailbox: "  . $check->Mailbox . "<br />\n" ;
    echo
"Messages: " . $check->Nmsgs   . "<br />\n" ;
    echo
"Recent: "   . $check->Recent  . "<br />\n" ;
    echo
"Unread: "   . $check->Unread  . "<br />\n" ;
    echo
"Deleted: "  . $check->Deleted . "<br />\n" ;
    echo
"Size: "     . $check->Size    . "<br />\n" ;
} else {
    echo
"imap_check() failed: " . imap_last_error() . "<br />\n";
}

imap_close($mbox);

?>