(DataFlex) Office365 IMAP OAuth2 with Shared Mailbox

See more Office365 Examples

Demonstrates how to authenticate using OAuth2 with shared mailboxes in outlook.office365.com. (SASL XOAUTH2 authentication for shared mailboxes in Office 365)

For more information, see https://docs.microsoft.com/en-us/exchange/client-developer/legacy-protocols/how-to-authenticate-an-imap-pop-smtp-application-by-using-oauth#sasl-xoauth2-authentication-for-shared-mailboxes-in-office-365

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoJsonToken
    Boolean iSuccess
    Handle hoImap
    String sTemp1

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

    // In case of shared mailbox access using OAuth, application needs to obtain the access token on behalf of a user
    // but replace the userName field in the SASL XOAUTH2 encoded string with the email address of the shared mailbox.

    // Login using the shared mailbox email address for the username, and the access token for the password.
    // This will cause the SASL XOAUTH2 format to be used, as described at Office 365 SASL XOAUTH2 format 

    Get ComStringOf Of hoJsonToken "access_token" To sTemp1
    Get ComLogin Of hoImap "SHARED_MAILBOX_EMAIL_ADDRESS" sTemp1 To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Showln "O365 OAuth2 shared mailbox 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