Tcl

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.

Tcl

load ./chilkat.dll

set success 0

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

set imap [new_CkImap]

# Use TLS
CkImap_put_Ssl $imap 1
CkImap_put_Port $imap 993
set success [CkImap_Connect $imap "MY-IMAP-DOMAIN"]
if {$success != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

# Authenticate
set success [CkImap_Login $imap "MY-IMAP-LOGIN" "MY-IMAP-PASSWORD"]
if {$success != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

# First check to see if the IMAP server supports the QUOTA extension.
set caps [CkImap_capability $imap]
if {[CkImap_get_LastMethodSuccess $imap] != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

if {[CkImap_HasCapability $imap "QUOTA" $caps] != 1} then {
    puts "IMAP server does not support the QUOTA extension."
    delete_CkImap $imap
    exit
}

set jsonStr [CkImap_getQuotaRoot $imap "Inbox"]
if {[CkImap_get_LastMethodSuccess $imap] != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

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

# This is easy to parse...
set json [new_CkJsonObject]

CkJsonObject_Load $json $jsonStr

# Get the quota root for Inbox, which is an empty string in the case above.
set quotaRoot [CkJsonObject_stringOf $json "QUOTAROOT.root"]
puts "{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.
set resourceName [CkJsonObject_stringOf $json "QUOTA.resource"]
set quotaUsed [CkJsonObject_IntOf $json "QUOTA.used"]
set quotaMax [CkJsonObject_IntOf $json "QUOTA.max"]

puts "Resource: $resourceName"
puts "Quota Used (in KB): $quotaUsed"
puts "Quota Max (in KB): $quotaMax"

# Disconnect from the IMAP server.
set success [CkImap_Disconnect $imap]

delete_CkImap $imap
delete_CkJsonObject $json