SQL Server

Office365 IMAP with Client Credentials

See more Office365 Examples

Demonstrates how to interact with the Office365 IMAP server using OAuth2 client credentials. This example uses a new feature available starting in Chilkat v9.5.0.97, which is to provide the client ID, client secret, and tenant ID to Chilkat, and internally Chilkat will fetch OAuth2 access token via client credentials as necessary. Therefore, it is no longer necessary for the application to explicitly fetch the OAuth2 access token beforehand.

Note: This requires the Azure Entra ID application to be configured for client credentials as detailed in this guide: Office365 App Setup for SMTP, POP, IMAP OAuth2 Client Credentials

Note: This example requires Chilkat v9.5.0.97 or greater.

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
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @success int
    SELECT @success = 0

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

    -- ----------------------------------------------------------------------------------------
    -- Important:
    -- Your Azure Entra ID app must be explicitly setup to allow for the OAuth2 client credentials flow.
    -- Please follow the detailed guide for how to do it here:
    -- Office365 App Setup for SMTP, POP, IMAP OAuth2 Client Credentials
    -- 
    -- Note: Your registered App must have the SMTP.SendAsApp permission.
    -- ----------------------------------------------------------------------------------------

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

    -- Use your App's actual client ID here:
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'client_id', '2871da2c-8176-4b7f-869b-2311aa82e743'

    -- Use your App's actual client secret here:
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'client_secret', '2hu9Q~r5QuryUcEkNbg1btLtnfU1VUXzhSCG6brH'

    -- Use this specific scope.
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'scope', 'https://outlook.office365.com/.default'

    -- Replace the tenant ID part of the URL with your tenant ID.
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'token_endpoint', 'https://login.microsoftonline.com/114d7ed6-71bf-4dbe-a866-748364121bf2/oauth2/v2.0/token'

    DECLARE @imap int
    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 @json
        EXEC @hr = sp_OADestroy @imap
        RETURN
      END

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

    -- Here is where we use a new feature introduced in Chilkat v9.5.0.97
    -- Instead of providing a previously fetched OAuth2 access token, we instead provide the information (above)
    -- required for Chilkat to automatically fetch the access token via client credentials.
    EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
    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 @json
        EXEC @hr = sp_OADestroy @imap
        RETURN
      END


    PRINT 'O365 IMAP OAuth2 authentication is successful.'

    -- Do something...
    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 @json
        EXEC @hr = sp_OADestroy @imap
        RETURN
      END

    -- Your application can continue to do other things in the IMAP session....

    -- When finished, logout and close the connection.
    EXEC sp_OAMethod @imap, 'Logout', @success OUT
    EXEC sp_OAMethod @imap, 'Disconnect', @success OUT


    PRINT 'Finished.'

    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @imap


END
GO