Home > PHP > Function > IMAP > imap_set_quota()

imap_set_quota()

imap_set_quota - Sets a quota for a given mailbox

Syntax

bool imap_set_quota (resource $imap_stream, string $quota_root, int $quota_limit)

Arguments

  • imap_stream - An IMAP stream returned by imap_open().
  • quota_root - The mailbox to have a quota set. This should follow the IMAP standard format for a mailbox: user.name.
  • quota_limit - The maximum size (in KB) for the quota_root

Description

Sets an upper limit quota on a per mailbox basis.

Version

PHP 4.0.5, 5

Return value

Returns TRUE on success or FALSE on failure.