(PureBasic) 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.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkImap.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

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

    imap.i = CkImap::ckCreate()
    If imap.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Use TLS
    CkImap::setCkSsl(imap, 1)
    CkImap::setCkPort(imap, 993)
    success.i = CkImap::ckConnect(imap,"MY-IMAP-DOMAIN")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Authenticate
    success = CkImap::ckLogin(imap,"MY-IMAP-LOGIN","MY-IMAP-PASSWORD")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; First check to see if the IMAP server supports the QUOTA extension.
    caps.s = CkImap::ckCapability(imap)
    If CkImap::ckLastMethodSuccess(imap) <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    If CkImap::ckHasCapability(imap,"QUOTA",caps) <> 1
        Debug "IMAP server does not support the QUOTA extension."
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    jsonStr.s = CkImap::ckGetQuotaRoot(imap,"Inbox")
    If CkImap::ckLastMethodSuccess(imap) <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

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

    ; This is easy to parse...
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoad(json,jsonStr)

    ; Get the quota root for Inbox, which is an empty string in the case above.
    quotaRoot.s = CkJsonObject::ckStringOf(json,"QUOTAROOT.root")
    Debug "Quota Root for Inbox: [" + quotaRoot + "]"

    ; 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.s = CkJsonObject::ckStringOf(json,"QUOTA.resource")
    quotaUsed.i = CkJsonObject::ckIntOf(json,"QUOTA.used")
    quotaMax.i = CkJsonObject::ckIntOf(json,"QUOTA.max")

    Debug "Resource: " + resourceName
    Debug "Quota Used (in KB): " + Str(quotaUsed)
    Debug "Quota Max (in KB): " + Str(quotaMax)

    ; Disconnect from the IMAP server.
    success = CkImap::ckDisconnect(imap)


    CkImap::ckDispose(imap)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure