(SQL Server) Get IMAP UID from Email Header

Demonstrates how to get the IMAP UID from an email header. After fetching an email or header using IMAP, the UID is contained in the ckx-imap-uid header field.

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 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, 'imap.someMailServer.com'
    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, 'login', '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

    DECLARE @fetchUids int
    SELECT @fetchUids = 1
    -- Get the message UIDs of all the emails in the mailbox
    DECLARE @messageSet int
    EXEC sp_OAMethod @imap, 'Search', @messageSet OUT, 'ALL', @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

    DECLARE @bundle int
    EXEC sp_OAMethod @imap, 'FetchHeaders', @bundle OUT, @messageSet
    EXEC sp_OAGetProperty @imap, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        EXEC @hr = sp_OADestroy @messageSet

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

    -- The UID of each fetched email header is available 
    -- in the ckx-imap-uid header field.
    DECLARE @i int
    SELECT @i = 0
    DECLARE @szBundle int
    EXEC sp_OAGetProperty @bundle, 'MessageCount', @szBundle OUT
    DECLARE @msOneMsg int
    -- Use "Chilkat_9_5_0.MessageSet" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.MessageSet', @msOneMsg OUT

    WHILE @i < @szBundle
      BEGIN
        DECLARE @email int
        EXEC sp_OAMethod @bundle, 'GetEmail', @email OUT, @i

        -- Build a message set containing one UID
        DECLARE @uidStr nvarchar(4000)
        EXEC sp_OAMethod @email, 'GetHeaderField', @uidStr OUT, 'ckx-imap-uid'
        EXEC sp_OAMethod @msOneMsg, 'FromCompactString', @success OUT, @uidStr

        -- Move this message to some other folder.
        EXEC sp_OAMethod @imap, 'MoveMessages', @success OUT, @msOneMsg, 'someOtherFolder'
        IF @success <> 1
          BEGIN
            EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
            PRINT @sTmp0
            -- Exit the loop...
            SELECT @i = @szBundle
          END

        EXEC @hr = sp_OADestroy @email

        SELECT @i = @i + 1
      END

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

    EXEC @hr = sp_OADestroy @messageSet

    EXEC @hr = sp_OADestroy @bundle


    EXEC @hr = sp_OADestroy @imap
    EXEC @hr = sp_OADestroy @msOneMsg


END
GO