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

imap_status
Prev	XXXI. IMAP Functions	Next

imap_status

Name

imap_status — Returns status information on the specified mailbox.

Synopsis

object imap_status(connection, mailbox, options); int connection: IMAP connection ID string mailbox: Mailbox name int options: Flags allowing additional functionality

Returns

An object containing status information; FALSE on error

Description

Returns status information on the specified mailbox .

options can be a bitmask of values and can be used to only return certain object properties. Valid values for options are:

`SA_MESSAGES`	Set status->messages to the number of messages in the mailbox
`SA_RECENT`	Set status->recent to the number of recent messages in the mailbox
`SA_UNSEEN`	Set status->unseen to the number of unseen (new) messages in the mailbox
`SA_UIDNEXT`	Set status->uidnext to the next uid to be used in the mailbox
`SA_UIDVALIDITY`	Set status->uidvalidity to a constant that changes when uids for the mailbox may no longer be valid
`SA_ALL`	Set all of the above

The selected flags are also returned in the object property flags which can be checked against the flags available in options .

Version

From versions 3.0.4 and 4.0

Example

Example 621. Print status information

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

$status = imap_status($imap, "{localhost}INBOX", SA_ALL);

echo "Messages: ", $status->messages, "<BR>\n";
echo "Recent: ", $status->recent, "<BR>\n";
echo "Unseen: ", $status->unseen, "<BR>\n";
echo "UIDnext: ", $status->uidnext, "<BR>\n";
echo "UIDvalidity: ", $status->uidvalidity, "<BR>\n";
echo "Flags: ", $status->flags, "<BR>\n";

var_dump($status);
imap_close($imap);
?>

Output
Messages: 6
Recent: 0
Unseen: 3
UIDnext: 8
UIDvalidity: 994216816
Flags: 31

Prev	Home	Next
imap_sort	Up	XXXII. Java Functions

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.