Home > PHP > Function > IMAP > imap_get_quotaroot()

imap_get_quotaroot()

imap_get_quotaroot - Retrieve the quota settings per user

Syntax

array imap_get_quotaroot (resource $imap_stream, string $quota_root)

Arguments

  • imap_stream - An IMAP stream returned by imap_open().
  • quota_root - quota_root should normally be in the form of which mailbox (i.e. INBOX).

Description

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.

Version

PHP 4.3.0, 5

Return value

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.