(Tcl) 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 Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# 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.
set jsonToken [new_CkJsonObject]

set success [CkJsonObject_LoadFile $jsonToken "qa_data/tokens/office365.json"]
if {$success == 0} then {
    puts "Failed to open the office365 OAuth JSON file."
    delete_CkJsonObject $jsonToken
    exit
}

set imap [new_CkImap]

CkImap_put_Ssl $imap 1
CkImap_put_Port $imap 993

# Connect to the Office365 IMAP server.
set success [CkImap_Connect $imap "outlook.office365.com"]
if {$success != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkJsonObject $jsonToken
    delete_CkImap $imap
    exit
}

# Use OAuth2 authentication.
CkImap_put_AuthMethod $imap "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 

set success [CkImap_Login $imap "SHARED_MAILBOX_EMAIL_ADDRESS" [CkJsonObject_stringOf $jsonToken "access_token"]]
if {$success != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkJsonObject $jsonToken
    delete_CkImap $imap
    exit
}

puts "O365 OAuth2 shared mailbox authentication is successful."

# Do something...
set success [CkImap_SelectMailbox $imap "Inbox"]
if {$success != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkJsonObject $jsonToken
    delete_CkImap $imap
    exit
}

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

# When finished, logout and close the connection.
set success [CkImap_Logout $imap]
set success [CkImap_Disconnect $imap]

puts "Finished."

delete_CkJsonObject $jsonToken
delete_CkImap $imap