SQL Server

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.

SQL Server

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @success int
    SELECT @success = 0

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

    DECLARE @imap int
    EXEC @hr = sp_OACreate 'Chilkat.Imap', @imap OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- Use TLS
    EXEC sp_OASetProperty @imap, 'Ssl', 1
    EXEC sp_OASetProperty @imap, 'Port', 993
    EXEC sp_OAMethod @imap, 'Connect', @success OUT, 'MY-IMAP-DOMAIN'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @imap
        RETURN
      END

    -- Authenticate
    EXEC sp_OAMethod @imap, 'Login', @success OUT, 'MY-IMAP-LOGIN', 'MY-IMAP-PASSWORD'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @imap
        RETURN
      END

    -- First check to see if the IMAP server supports the QUOTA extension.
    DECLARE @caps nvarchar(4000)
    EXEC sp_OAMethod @imap, 'Capability', @caps OUT
    EXEC sp_OAGetProperty @imap, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @imap
        RETURN
      END

    EXEC sp_OAMethod @imap, 'HasCapability', @iTmp0 OUT, 'QUOTA', @caps
    IF @iTmp0 <> 1
      BEGIN

        PRINT 'IMAP server does not support the QUOTA extension.'
        EXEC @hr = sp_OADestroy @imap
        RETURN
      END

    DECLARE @jsonStr nvarchar(4000)
    EXEC sp_OAMethod @imap, 'GetQuotaRoot', @jsonStr OUT, 'Inbox'
    EXEC sp_OAGetProperty @imap, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @imap
        RETURN
      END

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

    PRINT @jsonStr

    -- This is easy to parse...
    DECLARE @json int
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'Load', @success OUT, @jsonStr

    -- Get the quota root for Inbox, which is an empty string in the case above.
    DECLARE @quotaRoot nvarchar(4000)
    EXEC sp_OAMethod @json, 'StringOf', @quotaRoot OUT, 'QUOTAROOT.root'


    PRINT '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.
    DECLARE @resourceName nvarchar(4000)
    EXEC sp_OAMethod @json, 'StringOf', @resourceName OUT, 'QUOTA.resource'
    DECLARE @quotaUsed int
    EXEC sp_OAMethod @json, 'IntOf', @quotaUsed OUT, 'QUOTA.used'
    DECLARE @quotaMax int
    EXEC sp_OAMethod @json, 'IntOf', @quotaMax OUT, 'QUOTA.max'


    PRINT 'Resource: ' + @resourceName

    PRINT 'Quota Used (in KB): ' + @quotaUsed

    PRINT 'Quota Max (in KB): ' + @quotaMax

    -- Disconnect from the IMAP server.
    EXEC sp_OAMethod @imap, 'Disconnect', @success OUT

    EXEC @hr = sp_OADestroy @imap
    EXEC @hr = sp_OADestroy @json


END
GO