Home/ Manual/ imap / functions/ imap_set_quota

imap_set_quota

PHP function Edit on GitHub ✎

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

Sets a quota for a given mailbox

Description

imap_set_quota(IMAP\Connection $imap, string $quota_root, int $mailbox_size): bool

Sets an upper limit quota on a per mailbox basis.

Parameters

quota_root: The mailbox to have a quota set. This should follow the IMAP standard format for a mailbox: user.name.
mailbox_size: The maximum size (in KB) for the quota_root

Return Values

Success

Changelog

Version	Description

Examples

imap_set_quota() example

php

<?php
$mbox = imap_open("{imap.example.org:143}", "mailadmin", "password");

if (!imap_set_quota($mbox, "user.kalowsky", 3000)) {
    echo "Error in setting quota\n";
    return;
}

imap_close($mbox);
?>

Notes

This function is currently only available to users of the c-client2000 or greater library.

The given imap must be opened as the mail administrator, other wise this function will fail.