(SQL Server) Subscribe to Mailboxes and List Subscribed Mailboxes

Demonstrates how to list subscribed mailboxes, and unsubscribe/subscribe to a mailbox.

Note: This example requires Chilkat v11.0.0 or greater.

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

    -- Connect to an IMAP server.
    -- Use TLS
    EXEC sp_OASetProperty @imap, 'Ssl', 1
    EXEC sp_OASetProperty @imap, 'Port', 993
    EXEC sp_OAMethod @imap, 'Connect', @success OUT, 'imap.example.com'
    IF @success = 0
      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, 'myLogin', 'myPassword'
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @imap
        RETURN
      END

    -- First examine the already subscribed mailboxes.
    DECLARE @refName nvarchar(4000)
    SELECT @refName = ''
    DECLARE @wildcardedMailbox nvarchar(4000)
    SELECT @wildcardedMailbox = '*'
    DECLARE @subscribed int
    SELECT @subscribed = 1

    DECLARE @mboxes int
    EXEC @hr = sp_OACreate 'Chilkat.Mailboxes', @mboxes OUT

    EXEC sp_OAMethod @imap, 'MbxList', @success OUT, @subscribed, @refName, @wildcardedMailbox, @mboxes
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @imap
        EXEC @hr = sp_OADestroy @mboxes
        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

    PRINT '----'

    -- Sample output.

    -- INBOX
    -- INBOX/recent
    -- INBOX/misc
    -- INBOX/misc/solutions
    -- ...
    -- Outbox
    -- Deleted Items
    -- Sent Items
    -- Drafts
    -- Junk E-mail
    -- Trash
    -- Sent
    -- Templates

    -- Let's unsubscribe to "INBOX/misc/solutions".
    EXEC sp_OAMethod @imap, 'Unsubscribe', @success OUT, 'INBOX/misc/solutions'
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @imap
        EXEC @hr = sp_OADestroy @mboxes
        RETURN
      END

    -- Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is missing.
    EXEC sp_OAMethod @imap, 'MbxList', @success OUT, @subscribed, '', 'INBOX/misc*', @mboxes
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @imap
        EXEC @hr = sp_OADestroy @mboxes
        RETURN
      END

    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

    PRINT '----'

    -- Re-subscribe to "INBOX/misc/solutions".
    EXEC sp_OAMethod @imap, 'Subscribe', @success OUT, 'INBOX/misc/solutions'
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @imap
        EXEC @hr = sp_OADestroy @mboxes
        RETURN
      END

    -- Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is back in the list.
    EXEC sp_OAMethod @imap, 'MbxList', @success OUT, @subscribed, '', 'INBOX/misc*', @mboxes
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @imap
        EXEC @hr = sp_OADestroy @mboxes
        RETURN
      END

    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

    PRINT '----'

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

    EXEC @hr = sp_OADestroy @imap
    EXEC @hr = sp_OADestroy @mboxes


END
GO