imap_get_quotaroot

Retrieve the quota settings per user

&reftitle.description; ``array``false```imap_get_quotaroot` `IMAP\Connection` `imap` `string` `mailbox`

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.

&reftitle.parameters;

&imap.imap-parameter.imap;

`mailbox`

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

&reftitle.returnvalues;

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.

&reftitle.changelog;

&Version; | &Description;
&imap.changelog.imap-param;

&reftitle.examples;

### `imap_get_quotaroot` example

    <?php
    $mbox = imap_open("{imap.example.org}", "kalowsky", "password", OP_HALFOPEN)
          or die("can't connect: " . imap_last_error());

    $quota = imap_get_quotaroot($mbox, "INBOX");
    if (is_array($quota)) {
       $storage = $quota['STORAGE'];
       echo "STORAGE usage level is: " .  $storage['usage'];
       echo "STORAGE limit level is: " .  $storage['limit'];

       $message = $quota['MESSAGE'];
       echo "MESSAGE usage level is: " .  $message['usage'];
       echo "MESSAGE limit level is: " .  $message['limit'];

       /* ...  */

    }

    imap_close($mbox);
    ?>

&reftitle.notes;

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.

&reftitle.seealso;

- `imap_open`
- `imap_set_quota`
- `imap_get_quota`