Visual FoxPro

IMAP Get Quota Root

Sends the GETQUOTAROOT command to the IMAP server to get the quota root for a given mailbox. This also provides quota information for the given mailbox.

The GetQuotaRoot 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.

Visual FoxPro

LOCAL lnSuccess
LOCAL loImap
LOCAL lcCaps
LOCAL lcJsonStr
LOCAL loJson
LOCAL lcQuotaRoot
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

lcJsonStr = loImap.GetQuotaRoot("Inbox")
IF (loImap.LastMethodSuccess <> 1) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

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

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

* Get the quota root for Inbox, which is an empty string in the case above.
lcQuotaRoot = loJson.StringOf("QUOTAROOT.root")
? "Quota Root for Inbox: [" + lcQuotaRoot + "]"

* 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