(Visual FoxPro) Office365 IMAP List Mailboxes

See more Office365 Examples

List the Office365 IMAP mailboxes.

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

LOCAL loJsonToken
LOCAL lnSuccess
LOCAL loImap
LOCAL lcRefName
LOCAL lcWildcardedMailbox
LOCAL loMboxes
LOCAL 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.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJsonToken = CreateObject('Chilkat.JsonObject')
lnSuccess = loJsonToken.LoadFile("qa_data/tokens/office365.json")
IF (lnSuccess = 0) THEN
    ? "Failed to open the office365 OAuth JSON file."
    RELEASE loJsonToken
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Imap')
loImap = CreateObject('Chilkat.Imap')

loImap.Ssl = 1
loImap.Port = 993

* Connect to the Office365 IMAP server.
lnSuccess = loImap.Connect("outlook.office365.com")
IF (lnSuccess <> 1) THEN
    ? loImap.LastErrorText
    RELEASE loJsonToken
    RELEASE loImap
    CANCEL
ENDIF

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

* Login using our username (i.e. email address) and the access token for the password.
lnSuccess = loImap.Login("OFFICE365_EMAIL_ADDRESS",loJsonToken.StringOf("access_token"))
IF (lnSuccess <> 1) THEN
    ? loImap.LastErrorText
    RELEASE loJsonToken
    RELEASE loImap
    CANCEL
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 = 0) THEN
    ? loImap.LastErrorText
    RELEASE loJsonToken
    RELEASE loImap
    CANCEL
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.
lnSuccess = loImap.Disconnect()

RELEASE loMboxes

RELEASE loJsonToken
RELEASE loImap