Xojo Plugin

List IMAP Mailboxes

Demonstrates the Chilkat Imap.MbxList method, which lists matching mailboxes and appends them to a Mailboxes object. The first argument selects subscribed-only, the second is a reference name, the third is the mailbox name pattern, and the fourth is the Mailboxes object. This example lists all mailboxes and prints each name. (The object is not cleared on success, so avoid reusing one across calls to prevent duplicates.)

Background: This corresponds to the IMAP LIST command (or LSUB when subscribed-only is requested). The pattern uses IMAP wildcards: * matches across hierarchy levels while % matches within a single level, so Archive/% lists just the direct children of Archive. Each returned mailbox also carries flags you can inspect — for example HasInferiors (has sub-folders) and IsSelectable — which is how a client renders a folder tree.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the Imap.MbxList method, which lists matching mailboxes and appends them to a
//  Mailboxes object.  The 1st argument selects subscribed-only, the 2nd is a reference name,
//  the 3rd is the mailbox pattern, and the 4th is the Mailboxes object.

Dim imap As New Chilkat.Imap

imap.Ssl = True
imap.Port = 993

success = imap.Connect("imap.example.com")
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

success = imap.Login("user@example.com","myPassword")
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

//  List all mailboxes.  The first argument 0 requests all (not subscribed-only); "*" matches any name.
Dim mailboxes As New Chilkat.Mailboxes
success = imap.MbxList(False,"","*",mailboxes)
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

Dim n As Int32
n = mailboxes.Count
System.DebugLog("Mailboxes: " + Str(n))
Dim i As Int32
For i = 0 To n - 1
    System.DebugLog(mailboxes.GetName(i))
Next

success = imap.DisconnectERROR: ";" expected