imap_mailboxmsginfo

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.

表格 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

例子 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) { echo "Date: " . $check->Date . " \n" ; echo "Driver: " . $check->Driver . " \n" ; echo "Mailbox: " . $check->Mailbox . " \n" ; echo "Messages: " . $check->Nmsgs . " \n" ; echo "Recent: " . $check->Recent . " \n" ; echo "Unread: " . $check->Unread . " \n" ; echo "Deleted: " . $check->Deleted . " \n" ; echo "Size: " . $check->Size . " \n" ; } else { echo "imap_check() failed: " . imap_last_error() . " \n"; } imap_close($mbox); ?>

add a note User Contributed Notes

Maxg
31-Aug-2004 05:41


About the slowness of imap_mailboxmsginfo() : if used on an IMAP connection, I did checked my mailserver logs and it appeared to send FETCH commands to retrieve the headers of EVERY messages of the mailbox ...

So, if you have, let's say, 400 messages in a folder, the function will be very slow (>1.5 sec on a local server !) ... 



I strongly advise you to use imap_status() instead, which only sends one < STATUS "Mailbox/Name" (MESSAGES UNSEEN) > and is actually a lot faster (at least with IMAP, but that's maybe not true with POP3)

m at tacker dot org
12-Mar-2003 05:55


The runtime difference between imap_status and imap_mailboxmsginfo is very significant on large mailboxes



<?php



/** opening connection to a

   * mailbox with 3987 messages

   * and retrive status information **/

$mbox = imap_open ('{mail.somwhere.com:110}', $user, $password);



$mbox_info = imap_status($mbox, '{mail.somwhere.com:110}INBOX', SA_MESSAGES);

/** took 11.05 seconds **/



$mbox_info = imap_mailboxmsginfo($mbox);

/** took 6 minutes 5.382 seconds **/



?>

til_roque at yahoo dot com
04-Mar-2003 06:13


the 'recent' of this function returns the same as 'UIDvalidity' from imap_status() ... makes no sense (or dos it?)

js at jerntorget dot se, ej at jerntorget dot se
20-Sep-2002 10:29


then use imap_get_quotaroot().....



or use this one (works with qmail):

function get_quotaroot() {

if(!$socket = @fsockopen("your server", your port);

    return false;

fgets($socket, 1024);

fputs($socket, "a001 LOGIN ".$username." ".$password."\n");

fgets($socket, 1024);

fputs($socket, "a002 GETQUOTAROOT INBOX\n");

fgets($socket, 1024);

$result = fgets($socket, 1024);

fputs($socket, "a003 LOGOUT\n");

fgets($socket, 1024);

sscanf($result, '* QUOTA "ROOT" (STORAGE %d %d MESSAGE %d %d', $usedSize, $maxSize, $usedNum, $maxNum);

return array("usedSize" => $usedSize, "maxSize" => $maxSize, "usedNum" => $usedNum, "maxNum" => $maxNum);

}

stephane-wantiez at tiscalinet dot be
12-Aug-2002 04:13


imap_get_quota need you to be the admin of the mail server !

dolce at koulikov dot cc
13-Jan-2002 02:57


Don't lie... I've timed it, there is merely a time difference, besides it returns a lot of other useful info packed in an object!

whw at my169 dot com
04-Jan-2002 11:35


It is very slow,so don't use it to get mailbox size,used imap_get_quota instead.

add a note