Visual FoxPro

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.

Visual FoxPro

LOCAL lnSuccess
LOCAL loImap
LOCAL lcCaps
LOCAL lcJsonStr
LOCAL loJson
LOCAL lcResourceName
LOCAL lnQuotaUsed
LOCAL lnQuotaMax

lnSuccess = 0

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

loImap = CreateObject('Chilkat.Imap')

* Use TLS
loImap.Ssl = 1
loImap.Port = 993
lnSuccess = loImap.Connect("MY-IMAP-DOMAIN")
IF (lnSuccess <> 1) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

* Authenticate
lnSuccess = loImap.Login("MY-IMAP-LOGIN","MY-IMAP-PASSWORD")
IF (lnSuccess <> 1) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

* First check to see if the IMAP server supports the QUOTA extension.
lcCaps = loImap.Capability()
IF (loImap.LastMethodSuccess <> 1) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

IF (loImap.HasCapability("QUOTA",lcCaps) <> 1) THEN
    ? "IMAP server does not support the QUOTA extension."
    RELEASE loImap
    CANCEL
ENDIF

* 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 
lcJsonStr = loImap.GetQuota("")
IF (loImap.LastMethodSuccess <> 1) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

* The JSON string will look something like this:
* {"QUOTA":{"root":"","resource":"STORAGE","used":22216,"max":15728640}}
? lcJsonStr

* This is easy to parse...
loJson = CreateObject('Chilkat.JsonObject')
loJson.Load(lcJsonStr)

* 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.
lcResourceName = loJson.StringOf("QUOTA.resource")
lnQuotaUsed = loJson.IntOf("QUOTA.used")
lnQuotaMax = loJson.IntOf("QUOTA.max")

? "Resource: " + lcResourceName
? "Quota Used (in KB): " + STR(lnQuotaUsed)
? "Quota Max (in KB): " + STR(lnQuotaMax)

* Disconnect from the IMAP server.
lnSuccess = loImap.Disconnect()

RELEASE loImap
RELEASE loJson