(SQL Server) Transition from Imap.ListSubscribed to Imap.MbxList

Provides instructions for replacing deprecated ListSubscribed method calls with MbxList.

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

    -- ...
    -- ...

    DECLARE @reference nvarchar(4000)
    SELECT @reference = ''
    DECLARE @mbxPattern nvarchar(4000)
    SELECT @mbxPattern = '*'

    -- ------------------------------------------------------------------------
    -- The ListSubscribed method is deprecated:

    -- Lists only subscribed mailboxes.
    DECLARE @mboxesObj int
    EXEC sp_OAMethod @imap, 'ListSubscribed', @mboxesObj OUT, @reference, @mbxPattern
    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

    -- ...
    -- ...

    EXEC @hr = sp_OADestroy @mboxesObj

    -- ------------------------------------------------------------------------
    -- Do the equivalent using MbxList.
    -- Your application creates a new, empty Mailboxes object which is passed 
    -- in the last argument and filled upon success.

    -- Lists only subscribed mailboxes.
    DECLARE @subscribed int
    SELECT @subscribed = 1

    DECLARE @mboxes int
    -- Use "Chilkat_9_5_0.Mailboxes" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Mailboxes', @mboxes OUT

    DECLARE @success int
    EXEC sp_OAMethod @imap, 'MbxList', @success OUT, @subscribed, @reference, @mbxPattern, @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

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


END
GO