(Tcl) Office365 Refresh OAuth2 Access Token for SMTP, IMAP, POP

See more Office365 Examples

Demonstrates how to refresh an Office365 OAuth2 access token for use in the SMTP, IMAP, and POP3 protocols.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

# It is assumed we previously obtained an OAuth2 access token.
# This example loads the JSON access token file 
# saved by this example: Get Office365 SMTP/IMAP/POP3 OAuth2 Access Token

# Note: Refreshing an access token does not require user-interaction.  
# Only the act of getting the initial access token requires interactive authorization from the Office365 account owner 
# (i.e. a browser is displayed and the account owner authorizes access by the app).

# Once you have the initial access token, it can be refreshed over and over again with no limits.
# A typical strategy is to write your application to automatically refresh the access token 
# when authentication fails, and then retry the operation with the new access token.
# For example, see Auto-Refresh O365 Access Token when Sending Email

set jsonToken [new_CkJsonObject]

set success [CkJsonObject_LoadFile $jsonToken "qa_data/tokens/office365.json"]
if {$success != 1} then {
    puts "Failed to load office365.json"
    delete_CkJsonObject $jsonToken
    exit
}

# The access token JSON 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"
# }

set oauth2 [new_CkOAuth2]

# Update to use your token endpoint.
# In the Azure Portal, in "App registrations", go to "Endpoints" (located to the right of the "+ New registration" link.)
#    Find your endpoint for the "OAuth 2.0 token endpoint (v2)"
#    See Office365 OAuth2 Endpoints

CkOAuth2_put_TokenEndpoint $oauth2 "https://login.microsoftonline.com/xxxxxxxxxx-71bf-4ebe-a866-738364321bf2/oauth2/v2.0/token"

# Replace these with actual values.
CkOAuth2_put_ClientId $oauth2 "CLIENT_ID"
CkOAuth2_put_ClientSecret $oauth2 "CLIENT_SECRET"

# Get the "refresh_token"
CkOAuth2_put_RefreshToken $oauth2 [CkJsonObject_stringOf $jsonToken "refresh_token"]

# Send the HTTP POST to refresh the access token..
set success [CkOAuth2_RefreshAccessToken $oauth2]
if {$success != 1} then {
    puts [CkOAuth2_lastErrorText $oauth2]
    delete_CkJsonObject $jsonToken
    delete_CkOAuth2 $oauth2
    exit
}

puts "New access token: [CkOAuth2_accessToken $oauth2]"
puts "New refresh token: [CkOAuth2_refreshToken $oauth2]"

# Update the JSON with the new tokens.
CkJsonObject_UpdateString $jsonToken "access_token" [CkOAuth2_accessToken $oauth2]
CkJsonObject_UpdateString $jsonToken "refresh_token" [CkOAuth2_refreshToken $oauth2]

# Save the new JSON access token response to a file.
set sbJson [new_CkStringBuilder]

CkJsonObject_put_EmitCompact $jsonToken 0
CkJsonObject_EmitSb $jsonToken $sbJson
CkStringBuilder_WriteFile $sbJson "qa_data/tokens/office365.json" "utf-8" 0

puts "OAuth2 authorization granted!"
puts "New Access Token = [CkOAuth2_accessToken $oauth2]"

delete_CkJsonObject $jsonToken
delete_CkOAuth2 $oauth2
delete_CkStringBuilder $sbJson