IMAP_SET_QUOTA(3) 1 IMAP_SET_QUOTA(3)
imap_set_quota - Sets a quota for a given mailbox
SYNOPSIS
bool imap_set_quota (resource $imap_stream, string $quota_root, int $quota_limit)
DESCRIPTION
Sets an upper limit quota on a per mailbox basis.
PARAMETERS
o $
imap_stream -An IMAP stream returned by imap_open(3).
o $quota_root
- The mailbox to have a quota set. This should follow the IMAP standard format for a mailbox: user.name.
o $quota_limit
- The maximum size (in KB) for the $quota_root
RETURN VALUES
Returns TRUE on success or FALSE on failure.
EXAMPLES
Example #1
imap_set_quota(3) example
<?php
$mbox = imap_open("{imap.example.org:143}", "mailadmin", "password");
if (!imap_set_quota($mbox, "user.kalowsky", 3000)) {
echo "Error in setting quota
";
return;
}
imap_close($mbox);
?>
NOTES
This function is currently only available to users of the c-client2000 or greater library.
The given $imap_stream must be opened as the mail administrator, other wise this function will fail.
SEE ALSO
imap_open(3), imap_get_quota(3).
PHP Documentation Group IMAP_SET_QUOTA(3)
