SQL Server

IMAP Get List of Flags

See more IMAP Examples

When a mailbox is selected, the server response includes a list of flags:

The FLAGS response occurs as a result of a SELECT or EXAMINE command. The flag parenthesized list identifies the flags (at a minimum, the system-defined flags) that are applicable for this mailbox. Flags other than the system flags can also exist, depending on server implementation.

This example demonstrates how to capture the SELECT (or EXAMINE) response, and parse the list of flags. SQL Server

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

    DECLARE @imap int
    EXEC @hr = sp_OACreate 'Chilkat.Imap', @imap OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- This example requires the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    -- 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, '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

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

    -- The LastResponse property contains the full response of the last command.
    DECLARE @selectResponse nvarchar(4000)
    EXEC sp_OAGetProperty @imap, 'LastResponse', @selectResponse OUT

    PRINT @selectResponse

    -- For example, on GMail, the SELECT response looks like this:

    -- 	* FLAGS (\Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk)
    -- 	* OK [PERMANENTFLAGS (\Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk \*)] Flags permitted.
    -- 	* OK [UIDVALIDITY 3] UIDs valid.
    -- 	* 46 EXISTS
    -- 	* 0 RECENT
    -- 	* OK [UIDNEXT 4147] Predicted next UID.
    -- 	* OK [HIGHESTMODSEQ 402971]
    -- 	aaac OK [READ-WRITE] INBOX selected. (Success)

    -- The goal of this example is to capture the list of FLAGS.
    -- All IMAP servers will respond with the list of flags in a SPACE separated list enclosed in parentheses.

    DECLARE @sbResponse int
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponse OUT

    EXEC sp_OAMethod @sbResponse, 'Append', @success OUT, @selectResponse

    -- Get just the list of flags:
    DECLARE @sbFlagList int
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbFlagList OUT

    EXEC sp_OAMethod @sbResponse, 'GetAfterBetween', @sTmp0 OUT, '* FLAGS', '(', ')'
    EXEC sp_OAMethod @sbFlagList, 'Append', @success OUT, @sTmp0
    EXEC sp_OAMethod @sbFlagList, 'GetAsString', @sTmp0 OUT
    PRINT @sTmp0

    -- sbFlagList contains this:  
    -- 
    --     \Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk
    -- 

    -- Make sure no more than one SPACE char in a row exists.
    EXEC sp_OAMethod @sbFlagList, 'TrimInsideSpaces', @success OUT
    -- Modify sbFlagList to one flag per line
    DECLARE @numReplaced int
    EXEC sp_OAMethod @sbFlagList, 'Replace', @numReplaced OUT, ' ', CHAR(13) + CHAR(10)

    -- Load a StringTable with the flag names.
    DECLARE @flagsTable int
    EXEC @hr = sp_OACreate 'Chilkat.StringTable', @flagsTable OUT

    EXEC sp_OAMethod @flagsTable, 'AppendFromSb', @success OUT, @sbFlagList

    -- Iterate over the individual flag names:
    DECLARE @i int
    SELECT @i = 0
    EXEC sp_OAGetProperty @flagsTable, 'Count', @iTmp0 OUT
    WHILE @i < @iTmp0
      BEGIN

        EXEC sp_OAMethod @flagsTable, 'StringAt', @sTmp0 OUT, @i
        PRINT @i + ': ' + @sTmp0
        SELECT @i = @i + 1
      END

    -- The output is:
    -- 
    -- 	0: \Answered
    -- 	1: \Flagged
    -- 	2: \Draft
    -- 	3: \Deleted
    -- 	4: \Seen
    -- 	5: $Forwarded
    -- 	6: $NotPhishing
    -- 	7: $Phishing
    -- 	8: $label1
    -- 	9: $label2
    -- 	10: $label3
    -- 	11: $label4
    -- 	12: $label5
    -- 	13: Junk
    -- 	14: NonJunk
    -- 

    EXEC @hr = sp_OADestroy @imap
    EXEC @hr = sp_OADestroy @sbResponse
    EXEC @hr = sp_OADestroy @sbFlagList
    EXEC @hr = sp_OADestroy @flagsTable


END
GO