(SQL Server) Download IMAP Message Set using FetchBundle

Demonstrates how to read IMAP emails using the FetchBundle method.

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 requires 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 using TLS.
    EXEC sp_OASetProperty @imap, 'Ssl', 1
    EXEC sp_OASetProperty @imap, 'Port', 993
    DECLARE @success int
    EXEC sp_OAMethod @imap, 'Connect', @success OUT, 'imap.example.com'
    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, 'email_account_login', 'email_account_password'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @imap
        RETURN
      END

    -- Select an IMAP mailbox
    EXEC sp_OAMethod @imap, 'SelectMailbox', @success OUT, 'Inbox'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @imap
        RETURN
      END

    -- Search for messages with the word "test" in the subject.
    DECLARE @fetchUids int
    SELECT @fetchUids = 1
    DECLARE @messageSet int
    EXEC sp_OAMethod @imap, 'Search', @messageSet OUT, 'Subject test', @fetchUids
    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

    -- Download the messages in a single call to FetchBundle.
    -- 
    -- This only makes sense if the number of emails to be downloaded is not too large.  
    -- For example, you wouldn't want to download 10000 emails in a single call to FetchBundle.
    -- Why? For two reasons:  (1) It could potentially cause an out-of-memory condition, and 
    -- (2) it would take an extremely large amount of time.  The longer the amount of time,
    -- the greater the likelihood of some kind of external networking or server problem occuring,
    -- and if it happens, then you would need to re-download everything from the beginning again.
    -- For large numbers of emails, it's better to loop over the emails in the message set
    -- and download/process one at a time as shown here: Download IMAP Messages One at a Time
    -- Downloading one message at a time makes it possible to resume the downloads rather than restart the entire operation all over again.

    -- If the message set is reasonable in size, you can download all at once using FetchBundle:


    EXEC sp_OAGetProperty @messageSet, 'Count', @iTmp0 OUT
    PRINT 'Number of messages = ' + @iTmp0

    DECLARE @bundle int
    EXEC sp_OAMethod @imap, 'FetchBundle', @bundle OUT, @messageSet
    EXEC sp_OAGetProperty @imap, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC @hr = sp_OADestroy @messageSet

        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @imap
        RETURN
      END

    -- Display the Subject and From of each email.
    DECLARE @i int
    SELECT @i = 0
    DECLARE @numEmails int
    EXEC sp_OAGetProperty @bundle, 'MessageCount', @numEmails OUT
    WHILE @i < @numEmails
      BEGIN
        DECLARE @email int
        EXEC sp_OAMethod @bundle, 'GetEmail', @email OUT, @i

        EXEC sp_OAMethod @email, 'GetHeaderField', @sTmp0 OUT, 'Date'
        PRINT @sTmp0
        EXEC sp_OAGetProperty @email, 'Subject', @sTmp0 OUT
        PRINT @sTmp0
        EXEC sp_OAGetProperty @email, 'From', @sTmp0 OUT
        PRINT @sTmp0

        PRINT '--'

        EXEC @hr = sp_OADestroy @email

        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @messageSet

    EXEC @hr = sp_OADestroy @bundle


    EXEC @hr = sp_OADestroy @imap


END
GO