PowerBuilder

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.

PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Imap
string ls_Caps
string ls_JsonStr
oleobject loo_Json
string ls_ResourceName
integer li_QuotaUsed
integer li_QuotaMax

li_Success = 0

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

loo_Imap = create oleobject
li_rc = loo_Imap.ConnectToNewObject("Chilkat.Imap")
if li_rc < 0 then
    destroy loo_Imap
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Use TLS
loo_Imap.Ssl = 1
loo_Imap.Port = 993
li_Success = loo_Imap.Connect("MY-IMAP-DOMAIN")
if li_Success <> 1 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    return
end if

// Authenticate
li_Success = loo_Imap.Login("MY-IMAP-LOGIN","MY-IMAP-PASSWORD")
if li_Success <> 1 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    return
end if

// First check to see if the IMAP server supports the QUOTA extension.
ls_Caps = loo_Imap.Capability()
if loo_Imap.LastMethodSuccess <> 1 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    return
end if

if loo_Imap.HasCapability("QUOTA",ls_Caps) <> 1 then
    Write-Debug "IMAP server does not support the QUOTA extension."
    destroy loo_Imap
    return
end if

// 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 
ls_JsonStr = loo_Imap.GetQuota("")
if loo_Imap.LastMethodSuccess <> 1 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    return
end if

// The JSON string will look something like this:
// {"QUOTA":{"root":"","resource":"STORAGE","used":22216,"max":15728640}}
Write-Debug ls_JsonStr

// This is easy to parse...
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.Load(ls_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.
ls_ResourceName = loo_Json.StringOf("QUOTA.resource")
li_QuotaUsed = loo_Json.IntOf("QUOTA.used")
li_QuotaMax = loo_Json.IntOf("QUOTA.max")

Write-Debug "Resource: " + ls_ResourceName
Write-Debug "Quota Used (in KB): " + string(li_QuotaUsed)
Write-Debug "Quota Max (in KB): " + string(li_QuotaMax)

// Disconnect from the IMAP server.
li_Success = loo_Imap.Disconnect()


destroy loo_Imap
destroy loo_Json