PHP Manual
Prev |  | Next

# imap_mailboxmsginfo

(PHP 3>= 3.0.2, PHP 4 )

imap_mailboxmsginfo -- Get information about the current mailbox

## Description

object imap_mailboxmsginfo ( resource imap_stream)

Returns information about the current mailbox. Returns `FALSE` on failure.

The imap_mailboxmsginfo() function 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. It returns the information in an object with following properties.

Table 1. Mailbox properties

Date | date of last change
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

Example 1. imap_mailboxmsginfo() example
    <?php

    $mbox = imap_open("{your.imap.host}INBOX","username", "password")
          or die("can't connect: ".imap_last_error());

    $check = imap_mailboxmsginfo($mbox);

    if($check) {
        print "Date: "    . $check->Date    ."<br>\n" ;
        print "Driver: "  . $check->Driver  ."<br>\n" ;
        print "Mailbox: " . $check->Mailbox ."<br>\n" ;
        print "Messages: ". $check->Nmsgs   ."<br>\n" ;
        print "Recent: "  . $check->Recent  ."<br>\n" ;
        print "Unread: "  . $check->Unread  ."<br>\n" ;
        print "Deleted: " . $check->Deleted ."<br>\n" ;
        print "Size: "    . $check->Size    ."<br>\n" ;
    } else {
        print "imap_check() failed: ".imap_last_error(). "<br>\n";
    }

    imap_close($mbox);

    ?>

Prev | Home | Next
imap_mail | Up | imap_mime_header_decode