What is PhpDig?
PhpDig is a PHP MySQL based
Web Spider & Search Engine.

imap_mailboxmsginfo
Prev	XXXI. IMAP Functions	Next

imap_mailboxmsginfo

Name

imap_mailboxmsginfo — Gets information about the current mailbox.

Synopsis

object imap_mailboxmsginfo(connection); int connection: IMAP connection ID

Returns

Description

Mailbox information; FALSE on error

Retrieves information about the mailbox. This is usually the one specified using imap_open() unless imap_reopen() has been called. Eight properties for the mailbox are returned as an object.

`Unread`	Number of unread messages
`Deleted`	Number of deleted messages
`Nmsgs`	Number of messages
`Size`	Size of mailbox
`Date`	Date of last mailbox change
`Driver`	Driver (e.g. imap, nntp)
`Mailbox`	Mailbox name
`Recent`	Number of recent messages

Version

From versions 3.0.2 and 4.0

Example

Example 607. Print mailbox info

<?php
$imap = imap_open("{localhost}INBOX","graeme","inferno");

// retrieve mailbox information
$info = imap_mailboxmsginfo($imap);

echo "Date: " , $info->Date, "\n";
echo "Driver: ", $info->Driver, "\n";
echo "Mailbox: ", $info->Mailbox, "\n";
echo "Number of messages: ", $info->Nmsgs, "\n";
echo "Recent: ", $info->Recent, "\n";
echo "Unread; ", $info->Unread, "\n";
echo "Deleted: ", $info->Deleted, "\n";
echo "Size: ", $info->Size, "\n";

imap_close($imap);
?>

Output:
Date: Wed, 4 Jul 2001 17:08:59 +1000 (EST)
Driver: imap
Mailbox: {localhost:143/imap/user="graeme"}INBOX
Number of messages: 6
Recent: 0
Unread; 3
Deleted: 0
Size: 12686

Prev	Home	Next
imap_listmailbox	Up	imap_num_msg

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.