(Excel) List IMAP Mailboxes

List the mailboxes available within an IMAP account.

Download Excel Class Modules Chilkat Excel Class Modules

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim imap As Chilkat.Imap
Set imap = Chilkat.NewImap

' Connect to an IMAP server.
' Use TLS
imap.Ssl = True
imap.Port = 993

success = imap.Connect("MY-IMAP-DOMAIN")
If (success <> True) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

' Login
success = imap.Login("MY-IMAP-LOGIN","MY-IMAP-PASSWORD")
If (success <> True) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

' 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 = "*"


Set mboxes = imap.ListMailboxes(refName,wildcardedMailbox)
If (imap.LastMethodSuccess = False) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If


i = 0
Do While i < mboxes.Count
    Debug.Print mboxes.GetName(i)
    i = i + 1
Loop

' Sample output looks like this:
' INBOX.vendors.shareit
' INBOX.oldSupport
' INBOX.vendors.paypal
' INBOX.sales
' INBOX.lists
' INBOX.Drafts
' INBOX.vendors.dell
' INBOX.Trash
' INBOX.invoiceRequests
' INBOX.purchases
' INBOX.vendors.inMotion
' INBOX.oldEmail
' INBOX.vendors
' INBOX.lists.python
' INBOX.vendors.myhosting
' INBOX.Templates
' INBOX.friends
' INBOX.bounceSamples
' INBOX.lists.ruby
' INBOX.vendors.peer1
' INBOX.Sent
' INBOX.Junk
' INBOX

' Disconnect from the IMAP server.
success = imap.Disconnect()