Microsoft 365 IMAP: OAuth2 Login and Read-Only Inbox
See more IMAP Examples
Authenticate to outlook.office365.com:993 using XOAUTH2, then EXAMINE the Inbox without changing read flags. This is Exchange Online work/school access: the mailbox must permit IMAP and the app must satisfy tenant consent and access policy. Basic authentication and app passwords cannot restore removed IMAP Basic authentication.
Personal Outlook.com uses the same IMAP server, but requires personal-account delegated authorization and IMAP enabled in Outlook.com settings. To use it here, select that mailbox address and load qa_data/tokens/hotmail.json from the personal-account PKCE example. Application-only client credentials are an Exchange Online organizational scenario, not personal Outlook.com authorization.
First authorize the account with https://outlook.office.com/IMAP.AccessAsUser.All and offline_access, then refresh the access token when needed. This example reads qa_data/tokens/office365.json from a private working directory. Microsoft Graph permissions such as Mail.Send or Mail.Read do not authorize these mail protocols. Do not print tokens or authentication logs.
Microsoft reference documentation
Chilkat Visual FoxPro Downloads
LOCAL lnSuccess
LOCAL loToken
LOCAL lcMailbox
LOCAL loImap
lnSuccess = 0
* Assumes Chilkat is unlocked. See Global Unlock Sample.
loToken = CreateObject('Chilkat.JsonObject')
lnSuccess = loToken.LoadFile("qa_data/tokens/office365.json")
IF (lnSuccess <> 1) THEN
? "Could not read qa_data/tokens/office365.json from the private working directory."
RELEASE loToken
CANCEL
ENDIF
IF ((loToken.JsonTypeOf("access_token") <> 1) OR (loToken.StringOfEquals("access_token","",1) = 1)) THEN
? "An OAuth access token is required. Authorize or refresh the account first."
RELEASE loToken
CANCEL
ENDIF
lcMailbox = "user@example.com"
loImap = CreateObject('Chilkat.Imap')
loImap.Ssl = 1
loImap.Port = 993
loImap.RequireSslCertVerify = 1
loImap.AuthMethod = "XOAUTH2"
lnSuccess = loImap.Connect("outlook.office365.com")
IF (lnSuccess <> 1) THEN
? "Could not establish the Microsoft IMAP TLS connection."
RELEASE loToken
RELEASE loImap
CANCEL
ENDIF
lnSuccess = loImap.Login(lcMailbox,loToken.StringOf("access_token"))
IF (lnSuccess <> 1) THEN
loImap.Disconnect()
? "IMAP authentication failed. Check the mailbox, token scope, expiry, and account policy."
RELEASE loToken
RELEASE loImap
CANCEL
ENDIF
* EXAMINE is read-only; no message is downloaded, marked read, moved, or deleted.
lnSuccess = loImap.ExamineMailbox("INBOX")
IF (lnSuccess <> 1) THEN
loImap.Logout()
loImap.Disconnect()
? "Could not examine INBOX."
RELEASE loToken
RELEASE loImap
CANCEL
ENDIF
? "Messages in INBOX: " + STR(loImap.NumMessages)
lnSuccess = loImap.Logout()
loImap.Disconnect()
IF (lnSuccess <> 1) THEN
? "The read-only operation completed, but IMAP logout failed."
ENDIF
RELEASE loToken
RELEASE loImap