DataFlex

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. DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoJsonToken
    Handle hoOauth2
    Variant vSbJson
    Handle hoSbJson
    String sTemp1

    Move False To iSuccess

    // 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

    Get Create (RefClass(cComChilkatJsonObject)) To hoJsonToken
    If (Not(IsComObjectCreated(hoJsonToken))) Begin
        Send CreateComObject of hoJsonToken
    End
    Get ComLoadFile Of hoJsonToken "qa_data/tokens/office365.json" To iSuccess
    If (iSuccess <> True) Begin
        Showln "Failed to load office365.json"
        Procedure_Return
    End

    // 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"
    // }

    Get Create (RefClass(cComChilkatOAuth2)) To hoOauth2
    If (Not(IsComObjectCreated(hoOauth2))) Begin
        Send CreateComObject of hoOauth2
    End

    // 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

    Set ComTokenEndpoint Of hoOauth2 To "https://login.microsoftonline.com/xxxxxxxxxx-71bf-4ebe-a866-738364321bf2/oauth2/v2.0/token"

    // Replace these with actual values.
    Set ComClientId Of hoOauth2 To "CLIENT_ID"
    Set ComClientSecret Of hoOauth2 To "CLIENT_SECRET"

    // Get the "refresh_token"
    Get ComStringOf Of hoJsonToken "refresh_token" To sTemp1
    Set ComRefreshToken Of hoOauth2 To sTemp1

    // Send the HTTP POST to refresh the access token..
    Get ComRefreshAccessToken Of hoOauth2 To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoOauth2 To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComLastErrorText Of hoOauth2 To sTemp1
    Showln sTemp1

    Get ComAccessToken Of hoOauth2 To sTemp1
    Showln "New access token: " sTemp1
    Get ComRefreshToken Of hoOauth2 To sTemp1
    Showln "New refresh token: " sTemp1

    // Update the JSON with the new tokens.
    Get ComAccessToken Of hoOauth2 To sTemp1
    Get ComUpdateString Of hoJsonToken "access_token" sTemp1 To iSuccess
    Get ComRefreshToken Of hoOauth2 To sTemp1
    Get ComUpdateString Of hoJsonToken "refresh_token" sTemp1 To iSuccess

    // Save the new JSON access token response to a file.
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbJson
    If (Not(IsComObjectCreated(hoSbJson))) Begin
        Send CreateComObject of hoSbJson
    End
    Set ComEmitCompact Of hoJsonToken To False
    Get pvComObject of hoSbJson to vSbJson
    Get ComEmitSb Of hoJsonToken vSbJson To iSuccess
    Get ComWriteFile Of hoSbJson "qa_data/tokens/office365.json" "utf-8" False To iSuccess

    Showln "OAuth2 authorization granted!"
    Get ComAccessToken Of hoOauth2 To sTemp1
    Showln "New Access Token = " sTemp1


End_Procedure