PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
imap_get_quotaroot - Retrieve the quota settings per user
Code Examples

imap_get_quotaroot( IMAP\Connection$imap, string$mailbox ): array|false

Retrieve the quota settings per user. 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.



An IMAP\Connection instance.


mailbox should normally be in the form of which mailbox (i.e. INBOX).

Return Values

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.

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.

The imap should be opened as the user whose mailbox you wish to check.


Version Description
8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a resource was expected.

Related Functions

Example of imap_get_quotaroot

Show all examples for imap_get_quotaroot

PHP Version:

Function imap_get_quotaroot:

IMAP, POP3 and NNTP Functions

Most used PHP functions