SQL Server
SQL Server
Office365 OAuth2 Access Token for SMTP, IMAP, POP
See more Office365 Examples
Demonstrates how to get an OAuth2 access token for use in the SMTP, IMAP, and POP3 protocols.Note: It is only the initial access token that must be obtained interactively using a browser (see the code and comments below). Once the initial OAuth2 access token is obtained, then it can refreshed indefinitely with no user interaction.
Chilkat SQL Server Downloads
-- 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
-- This example requires the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
-- -----------------------------------------------------------------------------------------------
-- Important: Setup your App Registration in Azure beforehand.
--
-- See Create Azure App Registration for use with IMAP, POP3, and SMTP
--
-- Also, a detail that is often missed. Make sure to specify "Web" for your Redirect URI.
-- See Solution for Azure OAuth2 Error: Public clients can't send a client secret.
-- -----------------------------------------------------------------------------------------------
DECLARE @oauth2 int
EXEC @hr = sp_OACreate 'Chilkat.OAuth2', @oauth2 OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
-- This should be the port in the localhost callback URL for your app.
-- The callback URL would look like "http://localhost:3017/" if the port number is 3017.
EXEC sp_OASetProperty @oauth2, 'ListenPort', 3017
-- Specify your OAuth2 authorization and token endpoints
-- Replace "xxxxxxxxxx-71bf-4ebe-a866-738364321bf2" with your tenant ID,
-- or one of the following keywords: "common", "organizations", "consumers".
--
-- For more information about the /authorize endpoint, see Microsoft identity platform and OAuth 2.0 authorization code flow
EXEC sp_OASetProperty @oauth2, 'AuthorizationEndpoint', 'https://login.microsoftonline.com/xxxxxxxxxx-71bf-4ebe-a866-738364321bf2/oauth2/v2.0/authorize'
EXEC sp_OASetProperty @oauth2, 'TokenEndpoint', 'https://login.microsoftonline.com/xxxxxxxxxx-71bf-4ebe-a866-738364321bf2/oauth2/v2.0/token'
-- Replace these with actual values.
EXEC sp_OASetProperty @oauth2, 'ClientId', 'CLIENT_ID'
EXEC sp_OASetProperty @oauth2, 'ClientSecret', 'CLIENT_SECRET'
EXEC sp_OASetProperty @oauth2, 'CodeChallenge', 0
-- Provide a SPACE separated list of scopes.
-- Important: The offline_access scope is needed to get a refresh token.
EXEC sp_OASetProperty @oauth2, 'Scope', 'openid profile offline_access https://outlook.office365.com/SMTP.Send https://outlook.office365.com/POP.AccessAsUser.All https://outlook.office365.com/IMAP.AccessAsUser.All'
-- ----------------------------------------------------------------------
-- Note: It is only the initial access token that must be obtained interactively using a browser.
-- Once the initial OAuth2 access token is obtained, then it can refreshed indefinitely with no user interaction.
-- ----------------------------------------------------------------------
-- Begin the OAuth2 three-legged flow. This returns a URL that should be loaded in a browser.
DECLARE @url nvarchar(4000)
EXEC sp_OAMethod @oauth2, 'StartAuth', @url OUT
EXEC sp_OAGetProperty @oauth2, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @oauth2, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @oauth2
RETURN
END
-- Launch the system's default browser navigated to the URL.
EXEC sp_OAMethod @oauth2, 'LaunchBrowser', @success OUT, @url
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @oauth2, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @oauth2
RETURN
END
-- ----------------------------------------------------------------------
-- Note: Read about how browser caching of credentials can cause problems.
-- See OAuth2 Browser Caching Credentials
-- ----------------------------------------------------------------------
-- Now wait for the authorization.
-- We'll wait for a max of 90 seconds.
DECLARE @numMsWaited int
SELECT @numMsWaited = 0
EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
WHILE (@numMsWaited < 90000) and (@iTmp0 < 3)
BEGIN
EXEC sp_OAMethod @oauth2, 'SleepMs', NULL, 100
SELECT @numMsWaited = @numMsWaited + 100
END
-- If there was no response from the browser within 30 seconds, then
-- the AuthFlowState will be equal to 1 or 2.
-- 1: Waiting for Redirect. The OAuth2 background thread is waiting to receive the redirect HTTP request from the browser.
-- 2: Waiting for Final Response. The OAuth2 background thread is waiting for the final access token response.
-- In that case, cancel the background task started in the call to StartAuth.
EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
IF @iTmp0 < 3
BEGIN
EXEC sp_OAMethod @oauth2, 'Cancel', @success OUT
PRINT 'No response from the browser!'
EXEC @hr = sp_OADestroy @oauth2
RETURN
END
-- Check the AuthFlowState to see if authorization was granted, denied, or if some error occurred
-- The possible AuthFlowState values are:
-- 3: Completed with Success. The OAuth2 flow has completed, the background thread exited, and the successful JSON response is available in AccessTokenResponse property.
-- 4: Completed with Access Denied. The OAuth2 flow has completed, the background thread exited, and the error JSON is available in AccessTokenResponse property.
-- 5: Failed Prior to Completion. The OAuth2 flow failed to complete, the background thread exited, and the error information is available in the FailureInfo property.
EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
IF @iTmp0 = 5
BEGIN
PRINT 'OAuth2 failed to complete.'
EXEC sp_OAGetProperty @oauth2, 'FailureInfo', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @oauth2
RETURN
END
EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
IF @iTmp0 = 4
BEGIN
PRINT 'OAuth2 authorization was denied.'
EXEC sp_OAGetProperty @oauth2, 'AccessTokenResponse', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @oauth2
RETURN
END
EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
IF @iTmp0 <> 3
BEGIN
EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
PRINT 'Unexpected AuthFlowState:' + @iTmp0
EXEC @hr = sp_OADestroy @oauth2
RETURN
END
PRINT 'OAuth2 authorization granted!'
EXEC sp_OAGetProperty @oauth2, 'AccessToken', @sTmp0 OUT
PRINT 'Access Token = ' + @sTmp0
-- Get the full JSON response:
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAGetProperty @oauth2, 'AccessTokenResponse', @sTmp0 OUT
EXEC sp_OAMethod @json, 'Load', @success OUT, @sTmp0
EXEC sp_OASetProperty @json, 'EmitCompact', 0
-- The JSON response looks like this:
--
-- {
-- "token_type": "Bearer",
-- "scope": "IMAP.AccessAsUser.All openid POP.AccessAsUser.All profile SMTP.Send email",
-- "expires_in": 3599,
-- "ext_expires_in": 3599,
-- "access_token": "...",
-- "refresh_token": "...",
-- "id_token": "...",
-- "expires_on": "1592748507"
-- }
EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
PRINT @sTmp0
-- Save the JSON to a file for future requests.
DECLARE @fac int
EXEC @hr = sp_OACreate 'Chilkat.FileAccess', @fac OUT
EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
EXEC sp_OAMethod @fac, 'WriteEntireTextFile', @success OUT, 'qa_data/tokens/office365.json', @sTmp0, 'utf-8', 0
EXEC @hr = sp_OADestroy @oauth2
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @fac
END
GO