imap_status

Returns status information on a mailbox (PHP 4, PHP 5)
object imap_status ( resource imap_stream, string mailbox, int options )

Gets status information about the given mailbox.

Parameters

imap_stream

An IMAP stream returned by imap_open().

mailbox

The mailbox name, see imap_open() for more information

options

Valid flags 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

Return Values

This function returns an object containing status information. The object has the following properties: messages, recent, unseen, uidnext, and uidvalidity.

flags is also set, which contains a bitmask which can be checked against any of the above constants.

Examples

Example 1065. imap_status() example

copy to clipboard

<?php

$mbox = imap_open("{imap.example.com}", "username", "password", OP_HALFOPEN)

      or die("can't connect: " . imap_last_error());

$status = imap_status($mbox, "{imap.example.org}INBOX", SA_ALL);

if ($status) {

  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";

} else {

  echo "imap_status failed: " . imap_last_error() . "\n";

}

imap_close($mbox);
?>

Code Examples / Notes » imap_status

jille

In 'reply' to my previous post; I`m not sure of that anymore I think this trick works, but the rest of my script just sucks.. Conclusion: You can get the last UID by using status->uidnext-1 BUT: This is not a good way, if another message is added after your append and before your status; you are screwed

imap_status

Returns status information on a mailbox (PHP 4, PHP 5) object imap_status ( resource imap_stream, string mailbox, int options )

Parameters

Return Values

Examples

Example 1065. imap_status() example

Code Examples / Notes » imap_status

Change Language

Returns status information on a mailbox (PHP 4, PHP 5)
object imap_status ( resource imap_stream, string mailbox, int options )