(Lianja) Office365 IMAP List Mailboxes

See more Office365 Examples

List the Office365 IMAP mailboxes.

Chilkat Lianja Extension Download Chilkat Lianja Extension

// 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.
loJsonToken = createobject("CkJsonObject")
llSuccess = loJsonToken.LoadFile("qa_data/tokens/office365.json")
if (llSuccess = .F.) then
    ? "Failed to open the office365 OAuth JSON file."
    release loJsonToken
    return
endif

loImap = createobject("CkImap")

loImap.Ssl = .T.
loImap.Port = 993

// Connect to the Office365 IMAP server.
llSuccess = loImap.Connect("outlook.office365.com")
if (llSuccess <> .T.) then
    ? loImap.LastErrorText
    release loJsonToken
    release loImap
    return
endif

// Use OAuth2 authentication.
loImap.AuthMethod = "XOAUTH2"

// Login using our username (i.e. email address) and the access token for the password.
llSuccess = loImap.Login("OFFICE365_EMAIL_ADDRESS",loJsonToken.StringOf("access_token"))
if (llSuccess <> .T.) then
    ? loImap.LastErrorText
    release loJsonToken
    release loImap
    return
endif

? "O365 OAuth authentication is successful."

// The ListMailboxes method returns a Mailboxes object
// that contains the collection of mailboxes.
// It accepts two arguments: a refName and a wildcardedMailbox.

lcRefName = ""
// refName is usually set to an empty string.
// A non-empty reference name argument is the name of a mailbox or a level of
// mailbox hierarchy, and indicates the context in which the mailbox
// name is interpreted.

// Select all mailboxes matching this pattern:
lcWildcardedMailbox = "*"

loMboxes = loImap.ListMailboxes(lcRefName,lcWildcardedMailbox)
if (loImap.LastMethodSuccess = .F.) then
    ? loImap.LastErrorText
    release loJsonToken
    release loImap
    return
endif

i = 0
do while i < loMboxes.Count
    ? loMboxes.GetName(i)
    i = i + 1
enddo

// Sample output looks like this:
// Archive
// Calendar
// Calendar/Birthdays
// Calendar/United States holidays
// Contacts
// Conversation History
// Deleted Items
// Drafts
// INBOX
// INBOX/abc
// INBOX/misc
// INBOX/misc/birdeye
// INBOX/old
// INBOX/old/large
// INBOX/receipts
// Journal
// Junk Email
// Notes
// Outbox
// RSS Subscriptions
// Sent Items
// Sync Issues
// Sync Issues/Conflicts
// Sync Issues/Local Failures
// Sync Issues/Server Failures
// Tasks
// Trash

// Disconnect from the IMAP server.
llSuccess = loImap.Disconnect()

release loMboxes


release loJsonToken
release loImap