Ruby

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.

Ruby

require 'chilkat'

success = false

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

imap = Chilkat::CkImap.new()

# Use TLS
imap.put_Ssl(true)
imap.put_Port(993)
success = imap.Connect("MY-IMAP-DOMAIN")
if (success != true)
    print imap.lastErrorText() + "\n";
    exit
end

# Authenticate
success = imap.Login("MY-IMAP-LOGIN","MY-IMAP-PASSWORD")
if (success != true)
    print imap.lastErrorText() + "\n";
    exit
end

# First check to see if the IMAP server supports the QUOTA extension.
caps = imap.capability()
if (imap.get_LastMethodSuccess() != true)
    print imap.lastErrorText() + "\n";
    exit
end

if (imap.HasCapability("QUOTA",caps) != true)
    print "IMAP server does not support the QUOTA extension." + "\n";
    exit
end

jsonStr = imap.getQuotaRoot("Inbox")
if (imap.get_LastMethodSuccess() != true)
    print imap.lastErrorText() + "\n";
    exit
end

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

# This is easy to parse...
json = Chilkat::CkJsonObject.new()
json.Load(jsonStr)

# Get the quota root for Inbox, which is an empty string in the case above.
quotaRoot = json.stringOf("QUOTAROOT.root")
print "Quota Root for Inbox: [" + quotaRoot + "]" + "\n";

# 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 = json.stringOf("QUOTA.resource")
quotaUsed = json.IntOf("QUOTA.used")
quotaMax = json.IntOf("QUOTA.max")

print "Resource: " + resourceName + "\n";
print "Quota Used (in KB): " + quotaUsed.to_s() + "\n";
print "Quota Max (in KB): " + quotaMax.to_s() + "\n";

# Disconnect from the IMAP server.
success = imap.Disconnect()