List IMAP Mailboxes

List the mailboxes available within an IMAP account.

Download Chilkat .NET for 2.0 Framework

Download Chilkat .NET for 1.0 / 1.1 Framework

Dim imap As New Chilkat.Imap()

Dim success As Boolean

' Anything unlocks the component and begins a fully-functional 30-day trial.
success = imap.UnlockComponent("Anything for 30-day trial")
If (success <> true) Then
    MsgBox(imap.LastErrorText)
    Exit Sub
End If


' Connect to an IMAP server.
success = imap.Connect("mail.chilkatsoft.com")
If (success <> true) Then
    MsgBox(imap.LastErrorText)
    Exit Sub
End If


' Login
success = imap.Login("admin@chilkatsoft.com","*myPassword5*")
If (success <> true) Then
    MsgBox(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.

Dim refName As String
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:
Dim wildcardedMailbox As String
wildcardedMailbox = "*"

Dim mboxes As Chilkat.Mailboxes
mboxes = imap.ListMailboxes(refName,wildcardedMailbox)
If (mboxes Is Nothing ) Then
    MsgBox(imap.LastErrorText)
    Exit Sub
End If


Dim i As Integer
For i = 0 To mboxes.Count - 1
    TextBox1.Text = TextBox1.Text & mboxes.GetName(i) & vbCrLf
    TextBox1.Refresh()
Next

' 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.
imap.Disconnect()