DataFlex

Office365 IMAP with Client Credentials

See more Office365 Examples

Demonstrates how to interact with the Office365 IMAP server using OAuth2 client credentials. This example uses a new feature available starting in Chilkat v9.5.0.97, which is to provide the client ID, client secret, and tenant ID to Chilkat, and internally Chilkat will fetch OAuth2 access token via client credentials as necessary. Therefore, it is no longer necessary for the application to explicitly fetch the OAuth2 access token beforehand.

Note: This requires the Azure Entra ID application to be configured for client credentials as detailed in this guide: Office365 App Setup for SMTP, POP, IMAP OAuth2 Client Credentials

Note: This example requires Chilkat v9.5.0.97 or greater.

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoJson
    Handle hoImap
    String sTemp1

    Move False To iSuccess

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

    // ----------------------------------------------------------------------------------------
    // Important:
    // Your Azure Entra ID app must be explicitly setup to allow for the OAuth2 client credentials flow.
    // Please follow the detailed guide for how to do it here:
    // Office365 App Setup for SMTP, POP, IMAP OAuth2 Client Credentials
    // 
    // Note: Your registered App must have the SMTP.SendAsApp permission.
    // ----------------------------------------------------------------------------------------

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End

    // Use your App's actual client ID here:
    Get ComUpdateString Of hoJson "client_id" "2871da2c-8176-4b7f-869b-2311aa82e743" To iSuccess

    // Use your App's actual client secret here:
    Get ComUpdateString Of hoJson "client_secret" "2hu9Q~r5QuryUcEkNbg1btLtnfU1VUXzhSCG6brH" To iSuccess

    // Use this specific scope.
    Get ComUpdateString Of hoJson "scope" "https://outlook.office365.com/.default" To iSuccess

    // Replace the tenant ID part of the URL with your tenant ID.
    Get ComUpdateString Of hoJson "token_endpoint" "https://login.microsoftonline.com/114d7ed6-71bf-4dbe-a866-748364121bf2/oauth2/v2.0/token" To iSuccess

    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"

    // Here is where we use a new feature introduced in Chilkat v9.5.0.97
    // Instead of providing a previously fetched OAuth2 access token, we instead provide the information (above)
    // required for Chilkat to automatically fetch the access token via client credentials.
    Get ComEmit Of hoJson To sTemp1
    Get ComLogin Of hoImap "OFFICE365_EMAIL_ADDRESS" sTemp1 To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Showln "O365 IMAP OAuth2 authentication is successful."

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