Developer Forums | About Us | Site Map


Web Host
site hosted by netplex

Online Manuals


(PHP 4 >= 4.3.0)

imap_get_quotaroot --  Retrieve the quota settings per user


array imap_get_quotaroot ( resource imap_stream, string quota_root)

Returns an array of integer values pertaining to the specified user mailbox. All values contain a key based upon the resource name, and a corresponding array with the usage and limit values within.

The limit value represents the total amount of space allowed for this user's total mailbox usage. The usage value represents the user's current total mailbox capacity. This function will return FALSE in the case of call failure, and an array of information about the connection upon an un-parsable response from the server.

This function is currently only available to users of the c-client2000 or greater library.

imap_stream should be the value returned from an imap_open() call. This stream should be opened as the user whose mailbox you wish to check. quota_root should normally be in the form of which mailbox (i.e. INBOX).

Example 1. imap_get_quotaroot() example

$mbox = imap_open("{}","kalowsky","password",OP_HALFOPEN)
      or die("can't connect: ".imap_last_error());
$quota = imap_get_quotaroot($mbox, "INBOX");
if(is_array($quota)) {
   $storage = $quota_values['STORAGE'];
   print "STORAGE usage level is: " .  $storage['usage'];
   print "STORAGE limit level is: " .  $storage['limit'];

   $message = $quota_values['MESSAGE']; 
   print "MESSAGE usage level is: " .  $message['usage'];
   print "MESSAGE usage level is: " .  $message['limit'];

   /* ...  */ 


See also imap_open(), imap_set_quota() and imap_get_quota().

Copyright 2004-2017 All rights reserved. Site hosted by NETPLEX