(VBScript) Office365 IMAP List Mailboxes

See more Office365 Examples

List the Office365 IMAP mailboxes.

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

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

' 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")
set jsonToken = CreateObject("Chilkat.JsonObject")
success = jsonToken.LoadFile("qa_data/tokens/office365.json")
If (success = 0) Then
    outFile.WriteLine("Failed to open the office365 OAuth JSON file.")
    WScript.Quit
End If

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Imap")
set imap = CreateObject("Chilkat.Imap")

imap.Ssl = 1
imap.Port = 993

' Connect to the Office365 IMAP server.
success = imap.Connect("outlook.office365.com")
If (success <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

' Use OAuth2 authentication.
imap.AuthMethod = "XOAUTH2"

' Login using our username (i.e. email address) and the access token for the password.
success = imap.Login("OFFICE365_EMAIL_ADDRESS",jsonToken.StringOf("access_token"))
If (success <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

outFile.WriteLine("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.

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:
wildcardedMailbox = "*"

' mboxes is a Chilkat.Mailboxes
Set mboxes = imap.ListMailboxes(refName,wildcardedMailbox)
If (imap.LastMethodSuccess = 0) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

i = 0
Do While i < mboxes.Count
    outFile.WriteLine(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.
success = imap.Disconnect()


outFile.Close