Home > PHP > Function > IMAP > imap_get_quota()

imap_get_quota()

imap_get_quota - Retrieve the quota level settings, and usage statics per mailbox

Syntax

array imap_get_quota (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 user.namewhere name is the mailbox you wish to retrieve information about.

Description

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

Version

PHP 4.0.5, 5

Return value

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.