Returns an array with integer values limit and usage for
the given mailbox. The value of limit represents the total
amount of space allowed for this mailbox. The usage value
represents the mailboxes current level of capacity. Will
return FALSE in the case of
failure.
This function is currently only available to users of
the c-client2000 or greater library.
NOTE: For this function to work, the mail stream is
required to be opened as the mail-admin user. For a non-admin
user version of this function, please see the
imap_get_quotaroot() function of PHP.
imap_stream should be
the value returned from an
imap_open() call. NOTE: This
stream is required to be opened as the mail admin user for
the get_quota function to work.
quota_root should normally be in the form of
user.name where name is the mailbox you wish to retrieve
information about.
As of PHP version 4.3, the function more properly
reflects the functionality as dictated by the RFC 2087. The
array return value has changed to support an unlimited number
of returned resources (i.e. messages, or sub-folders) with
each named resource receiving an individual array key. Each
key value then contains an another array with the usage and
limit values within it. The example below shows the updated
returned output.
For backwards compatibility reasons, the originial
access methods are still available for use, although it is
suggested to update.
|
See also imap_open(),
imap_set_quota(),
imap_get_quotaroot().