(SQL Server) Office365 IMAP List Mailboxes

See more Office365 Examples

List the Office365 IMAP mailboxes.

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)
    -- An Office365 OAuth2 access token must first be obtained prior
    -- to running this code.

    -- Getting the OAuth2 access token for the 1st time requires the O365 account owner's 
    -- interactive authorizaition via a web browser.  Afterwards, the access token
    -- can be repeatedly refreshed automatically.

    -- See the following examples for getting and refreshing an OAuth2 access token

    -- Get Office365 SMTP/IMAP/POP3 OAuth2 Access Token
    -- Refresh Office365 SMTP/IMAP/POP3 OAuth2 Access Token

    -- First get our previously obtained OAuth2 access token.
    DECLARE @jsonToken int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonToken OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int
    EXEC sp_OAMethod @jsonToken, 'LoadFile', @success OUT, 'qa_data/tokens/office365.json'
    IF @success = 0
      BEGIN

        PRINT 'Failed to open the office365 OAuth JSON file.'
        EXEC @hr = sp_OADestroy @jsonToken
        RETURN
      END

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

    EXEC sp_OASetProperty @imap, 'Ssl', 1
    EXEC sp_OASetProperty @imap, 'Port', 993

    -- Connect to the Office365 IMAP server.
    EXEC sp_OAMethod @imap, 'Connect', @success OUT, 'outlook.office365.com'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @jsonToken
        EXEC @hr = sp_OADestroy @imap
        RETURN
      END

    -- Use OAuth2 authentication.
    EXEC sp_OASetProperty @imap, 'AuthMethod', 'XOAUTH2'

    -- Login using our username (i.e. email address) and the access token for the password.
    EXEC sp_OAMethod @jsonToken, 'StringOf', @sTmp0 OUT, 'access_token'
    EXEC sp_OAMethod @imap, 'Login', @success OUT, 'OFFICE365_EMAIL_ADDRESS', @sTmp0
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @jsonToken
        EXEC @hr = sp_OADestroy @imap
        RETURN
      END


    PRINT 'O365 OAuth authentication is successful.'

    -- The ListMailboxes method returns a Mailboxes object
    -- that contains the collection of mailboxes.
    -- It accepts two arguments: a refName and a wildcardedMailbox.

    DECLARE @refName nvarchar(4000)
    SELECT @refName = ''
    -- refName is usually set to an empty string.
    -- A non-empty reference name argument is the name of a mailbox or a level of
    -- mailbox hierarchy, and indicates the context in which the mailbox
    -- name is interpreted.

    -- Select all mailboxes matching this pattern:
    DECLARE @wildcardedMailbox nvarchar(4000)
    SELECT @wildcardedMailbox = '*'

    DECLARE @mboxes int
    EXEC sp_OAMethod @imap, 'ListMailboxes', @mboxes OUT, @refName, @wildcardedMailbox
    EXEC sp_OAGetProperty @imap, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @jsonToken
        EXEC @hr = sp_OADestroy @imap
        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

    -- Sample output looks like this:
    -- Archive
    -- Calendar
    -- Calendar/Birthdays
    -- Calendar/United States holidays
    -- Contacts
    -- Conversation History
    -- Deleted Items
    -- Drafts
    -- INBOX
    -- INBOX/abc
    -- INBOX/misc
    -- INBOX/misc/birdeye
    -- INBOX/old
    -- INBOX/old/large
    -- INBOX/receipts
    -- Journal
    -- Junk Email
    -- Notes
    -- Outbox
    -- RSS Subscriptions
    -- Sent Items
    -- Sync Issues
    -- Sync Issues/Conflicts
    -- Sync Issues/Local Failures
    -- Sync Issues/Server Failures
    -- Tasks
    -- Trash

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

    EXEC @hr = sp_OADestroy @mboxes


    EXEC @hr = sp_OADestroy @jsonToken
    EXEC @hr = sp_OADestroy @imap


END
GO