DataFlex

Office365 POP3 with Client Credentials

See more Office365 Examples

Demonstrates how to interact with the Office365 POP3 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 hoMailman
    Integer iNumEmails
    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(cComChilkatMailMan)) To hoMailman
    If (Not(IsComObjectCreated(hoMailman))) Begin
        Send CreateComObject of hoMailman
    End

    Set ComMailHost Of hoMailman To "outlook.office365.com"
    Set ComMailPort Of hoMailman To 995
    Set ComPopSsl Of hoMailman To True

    // Use your O365 email address here.
    Set ComPopUsername Of hoMailman To "OFFICE365_EMAIL_ADDRESS"

    // When using OAuth2 authentication, leave the password empty.
    Set ComPopPassword Of hoMailman To ""

    // 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
    Set ComOAuth2AccessToken Of hoMailman To sTemp1

    // Make the TLS connection to the outlook.office365.com POP3 server.
    Get ComPop3Connect Of hoMailman To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoMailman To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Authenticate using XOAUTH2
    Get ComPop3Authenticate Of hoMailman To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoMailman To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Find out how many emails are on the server..
    Get ComCheckMail Of hoMailman To iNumEmails
    If (iNumEmails < 0) Begin
        Get ComLastErrorText Of hoMailman To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Examine the POP3 session log:
    Get ComPop3SessionLog Of hoMailman To sTemp1
    Showln sTemp1

    // The POP3 session log will look something like this:

    // **** Connected to outlook.office365.com:995
    // < +OK The Microsoft Exchange POP3 service is ready. [QwBIADIAUABSADEAOABD...YwBvAG0A]
    // > AUTH XOAUTH2
    // < + 
    // > <base64 string in XOAUTH2 format>
    // < +OK User successfully authenticated.
    // > STAT
    // < +OK 3 375302

    // End the POP3 session and close the connection to the GMail server.
    Get ComPop3EndSession Of hoMailman To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoMailman To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Showln "Finished."


End_Procedure