(PHP Extension) IMAP Get Quota

Sends the GETQUOTA command to the IMAP server to get the quota information for a given quota root.

The GetQuota method is available in Chilkat starting at v9.5.0.58, and is only available for IMAP servers that support the QUOTA extension.

The information is returned in JSON format. This example demonstrates how to parse the JSON to get the desired information.

Typically, the quota root for the Inbox is the empty string. The GetQuotaRoot method can be called to get the quota root for a given mailbox.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$imap = new CkImap();

// Use TLS
$imap->put_Ssl(true);
$imap->put_Port(993);
$success = $imap->Connect('MY-IMAP-DOMAIN');
if ($success != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Authenticate
$success = $imap->Login('MY-IMAP-LOGIN','MY-IMAP-PASSWORD');
if ($success != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// First check to see if the IMAP server supports the QUOTA extension.
$caps = $imap->capability();
if ($imap->get_LastMethodSuccess() != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

if ($imap->HasCapability('QUOTA',$caps) != true) {
    print 'IMAP server does not support the QUOTA extension.' . "\n";
    exit;
}

// This example assumes we already know the quota root for the given mailbox.
// For Inbox, it is typically the empty string.  See the documentation and example 
// for the GetQuotaRoot method to query for the quota root of a mailbox.  
// (It's probably easier to use GetQuotaRoot because the mailbox name
// can be passed to it, and in addition, it returns the quota information.)
// method for details 
$jsonStr = $imap->getQuota('');
if ($imap->get_LastMethodSuccess() != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// The JSON string will look something like this:
// {"QUOTA":{"root":"","resource":"STORAGE","used":22216,"max":15728640}}
print $jsonStr . "\n";

// This is easy to parse...
$json = new CkJsonObject();
$json->Load($jsonStr);

// Now get the resource name (which can be STORAGE or MESSAGE) and the used/max values.
// Most servers have STORAGE quotas, which are for total capacity.  For example, GMail's
// STORAGE quota is 15GB (at the time of writing this example).
// A MESSAGE quota sets a limit on the number of messages.
$resourceName = $json->stringOf('QUOTA.resource');
$quotaUsed = $json->IntOf('QUOTA.used');
$quotaMax = $json->IntOf('QUOTA.max');

print 'Resource: ' . $resourceName . "\n";
print 'Quota Used (in KB): ' . $quotaUsed . "\n";
print 'Quota Max (in KB): ' . $quotaMax . "\n";

// Disconnect from the IMAP server.
$success = $imap->Disconnect();

?>