imap_get_quotaroot

    (PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)

    imap_get_quotaroot — Retrieve the quota settings per user

    Description

    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.

    Parameters

    imap

    An IMAP\Connection instance.

    mailbox

    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.

    Changelog

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

    Examples

    Example #1 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);
    ?>

    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.

    See Also

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 3 notes

    up
    5
    thomas dot hebinck at digionline dot de
    21 years ago
    ['STORAGE']['usage'] and ['STORAGE']['limit'] are values in KB (1024 Bytes)
    up
    2
    uphonesimon at gmail dot com
    19 years ago
    just to make a note for all the people that are wondering the differences between $quota['STORAGE'] and $quot['MESSAGE']
    the $quot['STORAGE'] is the size of the mailbox in KB
    but $quota['MESSAGE'] is actually the number of messages stored in the mailbox and the up limit of the total messages allowed
    up
    -3
    rodrigo dot tsuru at tsuru dot net
    20 years ago
    The example above isn't right. Replace with this:

    <?php
    $mbox     = imap_open("{your.imap.host}", "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 usage level is: " . $message['limit'];

    /* ... */

    }

    imap_close($mbox);
    ?>
    ＋add a note
    To Top