Xbase++

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.

Xbase++

LOCAL nSuccess
LOCAL oOauth2
LOCAL cUrl
LOCAL nNumMsWaited
LOCAL oJson
LOCAL oFac

nSuccess := 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.
//  -----------------------------------------------------------------------------------------------

oOauth2 := CreateObject("Chilkat.OAuth2")

//  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.
oOauth2: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 

oOauth2:AuthorizationEndpoint := "https://login.microsoftonline.com/xxxxxxxxxx-71bf-4ebe-a866-738364321bf2/oauth2/v2.0/authorize"
oOauth2:TokenEndpoint := "https://login.microsoftonline.com/xxxxxxxxxx-71bf-4ebe-a866-738364321bf2/oauth2/v2.0/token"

//  Replace these with actual values.
oOauth2:ClientId := "CLIENT_ID"
oOauth2:ClientSecret := "CLIENT_SECRET"

oOauth2:CodeChallenge := 0

//  Provide a SPACE separated list of scopes.
//  Important: The offline_access scope is needed to get a refresh token.
oOauth2: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.
cUrl := oOauth2:StartAuth()
IF (oOauth2:LastMethodSuccess == 0)
    ? oOauth2:LastErrorText
    oOauth2:destroy()
    RETURN
ENDIF

//  Launch the system's default browser navigated to the URL.
nSuccess := oOauth2:LaunchBrowser(cUrl)
IF (nSuccess == 0)
    ? oOauth2:LastErrorText
    oOauth2:destroy()
    RETURN
ENDIF

//  ----------------------------------------------------------------------
//  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.
nNumMsWaited := 0
DO WHILE (nNumMsWaited < 90000) .AND. (oOauth2:AuthFlowState < 3)
    oOauth2:SleepMs(100)
    nNumMsWaited := nNumMsWaited + 100
ENDDO

//  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.
IF (oOauth2:AuthFlowState < 3)
    oOauth2:Cancel()
    ? "No response from the browser!"
    oOauth2:destroy()
    RETURN
ENDIF

//  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.
IF (oOauth2:AuthFlowState == 5)
    ? "OAuth2 failed to complete."
    ? oOauth2:FailureInfo
    oOauth2:destroy()
    RETURN
ENDIF

IF (oOauth2:AuthFlowState == 4)
    ? "OAuth2 authorization was denied."
    ? oOauth2:AccessTokenResponse
    oOauth2:destroy()
    RETURN
ENDIF

IF (oOauth2:AuthFlowState != 3)
    ? "Unexpected AuthFlowState:" + Str(oOauth2:AuthFlowState)
    oOauth2:destroy()
    RETURN
ENDIF

? "OAuth2 authorization granted!"
? "Access Token = " + oOauth2:AccessToken

//  Get the full JSON response:
oJson := CreateObject("Chilkat.JsonObject")
oJson:Load(oOauth2:AccessTokenResponse)
oJson: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"
//  }

? oJson:Emit()

//  Save the JSON to a file for future requests.
oFac := CreateObject("Chilkat.FileAccess")
oFac:WriteEntireTextFile("qa_data/tokens/office365.json", oJson:Emit(), "utf-8", 0)

oOauth2:destroy()
oJson:destroy()
oFac:destroy()