DataFlex

IMAP Auto-Refresh Office365 Access Token

See more Office365 Examples

Demonstrates how to automatically recover from an expired access token when OAuth2 authentication fails in the IMAP protocol. If the server responds with "NO AUTHENTICATE failed.", then we refresh the access token and retry. DataFlex

Use ChilkatAx-win32.pkg

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

    Move False To iSuccess

    // An Office365 OAuth2 access token must first be obtained prior
    // to running this code.

    // Getting the OAuth2 access token for the 1st time requires the O365 account owner's 
    // interactive authorizaition via a web browser.  Afterwards, the access token
    // can be repeatedly refreshed automatically.

    // See the following examples for getting and refreshing an OAuth2 access token

    // Get Office365 SMTP/IMAP/POP3 OAuth2 Access Token
    // Refresh Office365 SMTP/IMAP/POP3 OAuth2 Access Token

    // First get our previously obtained OAuth2 access token.
    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 = False) Begin
        Showln "Failed to open the office365 OAuth JSON file."
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatImap)) To hoImap
    If (Not(IsComObjectCreated(hoImap))) Begin
        Send CreateComObject of hoImap
    End

    Set ComSsl Of hoImap To True
    Set ComPort Of hoImap To 993

    // Connect to the Office365 IMAP server.
    Get ComConnect Of hoImap "outlook.office365.com" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Use OAuth2 authentication.
    Set ComAuthMethod Of hoImap To "XOAUTH2"

    // Login using our username (i.e. email address) and the access token for the password.
    Get ComStringOf Of hoJsonToken "access_token" To sTemp1
    Get ComLogin Of hoImap "OFFICE365_EMAIL_ADDRESS" sTemp1 To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sLoginLastErrorText

        // If we're still connected to the mail server, then it means the server sent a non-success response,
        // Such as:  NO AUTHENTICATE failed.
        Get ComIsConnected Of hoImap To bTemp1
        If (bTemp1 = True) Begin

            // Refresh the OAuth2 access token, and if successful, save the new (refreshed) access token and try authenticating again.
            Get Create (RefClass(cComChilkatOAuth2)) To hoOauth2
            If (Not(IsComObjectCreated(hoOauth2))) Begin
                Send CreateComObject of hoOauth2
            End

            // Use your actual Directory (tenant) ID instead of "112d7ed6-71bf-4eba-a866-738364321bfc"
            Set ComTokenEndpoint Of hoOauth2 To "https://login.microsoftonline.com/112d7ed6-71bf-4eba-a866-738364321bfc/oauth2/v2.0/token"

            // Replace these with your Azure App Registration's 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 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

            Get ComAccessToken Of hoOauth2 To sTemp1
            Showln "New Access Token = " sTemp1

            // Retry the login.
            Get ComStringOf Of hoJsonToken "access_token" To sTemp1
            Get ComLogin Of hoImap "OFFICE365_EMAIL_ADDRESS" sTemp1 To iSuccess
            If (iSuccess = False) Begin
                Get ComLastErrorText Of hoImap To sTemp1
                Showln sTemp1
                Procedure_Return
            End

        End
        Else Begin
            // Show the last error text for the call to Login
            Showln sLoginLastErrorText
            Procedure_Return
        End

    End
    Else Begin
        Showln "O365 OAuth authentication is successful."
    End

    // Do something...
    Get ComSelectMailbox Of hoImap "Inbox" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

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

    // When finished, logout and close the connection.
    Get ComLogout Of hoImap To iSuccess
    Get ComDisconnect Of hoImap To iSuccess

    Showln "Finished."


End_Procedure