(DataFlex) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoImap
    Boolean iSuccess
    String sCaps
    String sJsonStr
    Handle hoJson
    String sResourceName
    Integer iQuotaUsed
    Integer iQuotaMax
    String sTemp1
    Boolean bTemp1

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

    Get Create (RefClass(cComChilkatImap)) To hoImap
    If (Not(IsComObjectCreated(hoImap))) Begin
        Send CreateComObject of hoImap
    End

    // Use TLS
    Set ComSsl Of hoImap To True
    Set ComPort Of hoImap To 993
    Get ComConnect Of hoImap "MY-IMAP-DOMAIN" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Authenticate
    Get ComLogin Of hoImap "MY-IMAP-LOGIN" "MY-IMAP-PASSWORD" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // First check to see if the IMAP server supports the QUOTA extension.
    Get ComCapability Of hoImap To sCaps
    Get ComLastMethodSuccess Of hoImap To bTemp1
    If (bTemp1 <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComHasCapability Of hoImap "QUOTA" sCaps To bTemp1
    If (bTemp1 <> True) Begin
        Showln "IMAP server does not support the QUOTA extension."
        Procedure_Return
    End

    // 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 
    Get ComGetQuota Of hoImap "" To sJsonStr
    Get ComLastMethodSuccess Of hoImap To bTemp1
    If (bTemp1 <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // The JSON string will look something like this:
    // {"QUOTA":{"root":"","resource":"STORAGE","used":22216,"max":15728640}}
    Showln sJsonStr

    // This is easy to parse...
    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComLoad Of hoJson sJsonStr To iSuccess

    // 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.
    Get ComStringOf Of hoJson "QUOTA.resource" To sResourceName
    Get ComIntOf Of hoJson "QUOTA.used" To iQuotaUsed
    Get ComIntOf Of hoJson "QUOTA.max" To iQuotaMax

    Showln "Resource: " sResourceName
    Showln "Quota Used (in KB): " iQuotaUsed
    Showln "Quota Max (in KB): " iQuotaMax

    // Disconnect from the IMAP server.
    Get ComDisconnect Of hoImap To iSuccess


End_Procedure