(PowerBuilder) Office365 IMAP List Mailboxes

See more Office365 Examples

List the Office365 IMAP mailboxes.

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

integer li_rc
oleobject loo_JsonToken
integer li_Success
oleobject loo_Imap
string ls_RefName
string ls_WildcardedMailbox
oleobject loo_Mboxes
integer i

// 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.
loo_JsonToken = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JsonToken.ConnectToNewObject("Chilkat.JsonObject")
if li_rc < 0 then
    destroy loo_JsonToken
    MessageBox("Error","Connecting to COM object failed")
    return
end if
li_Success = loo_JsonToken.LoadFile("qa_data/tokens/office365.json")
if li_Success = 0 then
    Write-Debug "Failed to open the office365 OAuth JSON file."
    destroy loo_JsonToken
    return
end if

loo_Imap = create oleobject
// Use "Chilkat_9_5_0.Imap" for versions of Chilkat < 10.0.0
li_rc = loo_Imap.ConnectToNewObject("Chilkat.Imap")

loo_Imap.Ssl = 1
loo_Imap.Port = 993

// Connect to the Office365 IMAP server.
li_Success = loo_Imap.Connect("outlook.office365.com")
if li_Success <> 1 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_JsonToken
    destroy loo_Imap
    return
end if

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

// Login using our username (i.e. email address) and the access token for the password.
li_Success = loo_Imap.Login("OFFICE365_EMAIL_ADDRESS",loo_JsonToken.StringOf("access_token"))
if li_Success <> 1 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_JsonToken
    destroy loo_Imap
    return
end if

Write-Debug "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.

ls_RefName = ""
// 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:
ls_WildcardedMailbox = "*"

loo_Mboxes = loo_Imap.ListMailboxes(ls_RefName,ls_WildcardedMailbox)
if loo_Imap.LastMethodSuccess = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_JsonToken
    destroy loo_Imap
    return
end if

i = 0
do while i < loo_Mboxes.Count
    Write-Debug loo_Mboxes.GetName(i)
    i = i + 1
loop

// 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.
li_Success = loo_Imap.Disconnect()

destroy loo_Mboxes


destroy loo_JsonToken
destroy loo_Imap