Xojo Plugin Requires Chilkat v11.0.0+

List IMAP Mailboxes

List the mailboxes available within an IMAP account. Xojo Plugin

Dim success As Boolean
success = False

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

Dim imap As New Chilkat.Imap

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

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

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 subscribed As Boolean
subscribed = False

Dim mboxes As New Chilkat.Mailboxes
success = imap.MbxList(subscribed,refName,wildcardedMailbox,mboxes)
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

Dim i As Int32
i = 0
While i < mboxes.Count
    System.DebugLog(mboxes.GetName(i))
    i = i + 1
Wend

//  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()