(SQL Server) List IMAP Mailboxes

List the mailboxes available within an IMAP account.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- 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)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @imap int
    -- Use "Chilkat_9_5_0.Imap" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Imap', @imap OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- Connect to an IMAP server.
    -- Use TLS
    EXEC sp_OASetProperty @imap, 'Ssl', 1
    EXEC sp_OASetProperty @imap, 'Port', 993
    DECLARE @success int
    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

    -- Login
    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

    -- The ListMailboxes method returns a Mailboxes object
    -- that contains the collection of mailboxes.
    -- It accepts two arguments: a refName and a wildcardedMailbox.

    DECLARE @refName nvarchar(4000)
    SELECT @refName = ''
    -- refName is usually set to an empty string.
    -- A non-empty reference name argument is the name of a mailbox or a level of
    -- mailbox hierarchy, and indicates the context in which the mailbox
    -- name is interpreted.

    -- Select all mailboxes matching this pattern:
    DECLARE @wildcardedMailbox nvarchar(4000)
    SELECT @wildcardedMailbox = '*'

    DECLARE @mboxes int
    EXEC sp_OAMethod @imap, 'ListMailboxes', @mboxes OUT, @refName, @wildcardedMailbox
    EXEC sp_OAGetProperty @imap, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @imap
        RETURN
      END

    DECLARE @i int
    SELECT @i = 0
    EXEC sp_OAGetProperty @mboxes, 'Count', @iTmp0 OUT
    WHILE @i < @iTmp0
      BEGIN
        EXEC sp_OAMethod @mboxes, 'GetName', @sTmp0 OUT, @i
        PRINT @sTmp0
        SELECT @i = @i + 1
      END

    -- Sample output looks like this:
    -- INBOX.vendors.shareit
    -- INBOX.oldSupport
    -- INBOX.vendors.paypal
    -- INBOX.sales
    -- INBOX.lists
    -- INBOX.Drafts
    -- INBOX.vendors.dell
    -- INBOX.Trash
    -- INBOX.invoiceRequests
    -- INBOX.purchases
    -- INBOX.vendors.inMotion
    -- INBOX.oldEmail
    -- INBOX.vendors
    -- INBOX.lists.python
    -- INBOX.vendors.myhosting
    -- INBOX.Templates
    -- INBOX.friends
    -- INBOX.bounceSamples
    -- INBOX.lists.ruby
    -- INBOX.vendors.peer1
    -- INBOX.Sent
    -- INBOX.Junk
    -- INBOX

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

    EXEC @hr = sp_OADestroy @mboxes


    EXEC @hr = sp_OADestroy @imap


END
GO