Sample code for 30+ languages & platforms
B4X Requires Chilkat v11.0.0+

List IMAP Mailboxes

List the mailboxes available within an IMAP account.

Chilkat B4X Downloads

B4X
Dim success As Boolean = False

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

Dim imap As ChilkatImap
imap.Initialize("imap")

'  Connect to an IMAP server.
'  Use TLS
imap.Ssl = True
imap.Port = 993
success = imap.Connect("MY-IMAP-DOMAIN")
If success = False Then
    Log(imap.LastErrorText)
    Return
End If


'  Login
success = imap.Login("MY-IMAP-LOGIN", "MY-IMAP-PASSWORD")
If success = False Then
    Log(imap.LastErrorText)
    Return
End If


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

Dim subscribed As Boolean = False

Dim mboxes As ChilkatMailboxes
mboxes.Initialize
success = imap.MbxList(subscribed, refName, wildcardedMailbox, mboxes)
If success = False Then
    Log(imap.LastErrorText)
    Return
End If


Dim i As Int = 0
Do While i < mboxes.Count
    Log(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