Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

Excel Examples

Web API Categories

ASN.1
Amazon EC2
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Azure Cloud Storage
Azure Service Bus
Azure Table Service
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
EBICS
ECC
Ed25519
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
GMail SMTP/IMAP/POP
Geolocation
Google APIs
Google Calendar
Google Cloud SQL
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text
HTTP

HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
MS Storage Providers
Microsoft Graph
NTLM
OAuth1
OAuth2
OIDC
Office365
OneDrive
OpenSSL
Outlook
Outlook Calendar
Outlook Contact
PDF Signatures
PEM
PFX/P12
PKCS11
POP3
PRNG
REST
REST Misc
RSA
SCP
SCard
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
ScMinidriver
SharePoint
Socket/SSL/TLS
Spider
Stream
Tar Archive
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(Excel) Office365 IMAP OAuth2 with Shared Mailbox

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

Download Excel Class Modules

Chilkat Excel Class Modules

' 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.
Dim jsonToken As Chilkat.JsonObject
Set jsonToken = Chilkat.NewJsonObject

success = jsonToken.LoadFile("qa_data/tokens/office365.json")
If (success = False) Then
    Debug.Print "Failed to open the office365 OAuth JSON file."
    Exit Sub
End If

Dim imap As Chilkat.Imap
Set imap = Chilkat.NewImap

imap.Ssl = True
imap.Port = 993

' Connect to the Office365 IMAP server.
success = imap.Connect("outlook.office365.com")
If (success <> True) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

' Use OAuth2 authentication.
imap.AuthMethod = "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 

success = imap.Login("SHARED_MAILBOX_EMAIL_ADDRESS",jsonToken.StringOf("access_token"))
If (success <> True) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

Debug.Print "O365 OAuth2 shared mailbox authentication is successful."

' Do something...
success = imap.SelectMailbox("Inbox")
If (success <> True) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

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

' When finished, logout and close the connection.
success = imap.Logout()
success = imap.Disconnect()

Debug.Print "Finished."

 

© 2000-2022 Chilkat Software, Inc. All Rights Reserved.