imap_get_quota

Retrieve the quota level settings, and usage statics per mailbox.

imap_get_quota Function synopsis

imap_get_quota(IMAP\Connection $imap, string $quota_root): array|false

Parameters

$imap

TypeIMAP\Connection

$quota_root

Typestring

$quota_root should normally be in the form of user.name where name is the mailbox you wish to retrieve information about.

Return value

Typearray|false

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.

As of PHP 4.3, the function more properly reflects the functionality as dictated by the RFC2087. 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.

For backwards compatibility reasons, the original access methods are still available for use, although it is suggested to update.