(Xojo Plugin) Subscribe to Mailboxes and List Subscribed Mailboxes

Demonstrates how to list subscribed mailboxes, and unsubscribe/subscribe to a mailbox.

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// 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
Dim success As Boolean
success = imap.Connect("imap.someMailServer.com")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Login
success = imap.Login("myLogin","myPassword")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// First examine the already subscribed mailboxes.
Dim refName As String
refName = ""
Dim wildcardedMailbox As String
wildcardedMailbox = "*"

// Alternatively, the ListMailboxes method can be called to list all mailboxes (both subscribed and unsubscribed).
Dim mboxes As Chilkat.Mailboxes
mboxes = imap.ListSubscribed(refName,wildcardedMailbox)
If (imap.LastMethodSuccess <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

Dim i As Int32
For i = 0 To mboxes.Count - 1
    System.DebugLog(mboxes.GetName(i))
Next
System.DebugLog("----")

// Sample output.

// INBOX
// INBOX/recent
// INBOX/misc
// INBOX/misc/solutions
// ...
// Outbox
// Deleted Items
// Sent Items
// Drafts
// Junk E-mail
// Trash
// Sent
// Templates

// Let's unsubscribe to "INBOX/misc/solutions".
success = imap.Unsubscribe("INBOX/misc/solutions")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is missing.
mboxes = imap.ListSubscribed("","INBOX/misc*")
If (imap.LastMethodSuccess <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

For i = 0 To mboxes.Count - 1
    System.DebugLog(mboxes.GetName(i))
Next

System.DebugLog("----")

// Re-subscribe to "INBOX/misc/solutions".
success = imap.Subscribe("INBOX/misc/solutions")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is back in the list.
mboxes = imap.ListSubscribed("","INBOX/misc*")
If (imap.LastMethodSuccess <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

For i = 0 To mboxes.Count - 1
    System.DebugLog(mboxes.GetName(i))
Next

System.DebugLog("----")

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