Xojo Plugin Requires Chilkat v11.0.0+

Subscribe to Mailboxes and List Subscribed Mailboxes

See more IMAP Examples

Demonstrates how to list subscribed mailboxes, and unsubscribe/subscribe to a mailbox. 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("imap.example.com")
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

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

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

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
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 = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

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

i = 0
While i < mboxes.Count
    System.DebugLog(mboxes.GetName(i))
    i = i + 1
Wend
System.DebugLog("----")

//  Re-subscribe to "INBOX/misc/solutions".
success = imap.Subscribe("INBOX/misc/solutions")
If (success = False) 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.
success = imap.MbxList(subscribed,"","INBOX/misc*",mboxes)
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

i = 0
While i < mboxes.Count
    System.DebugLog(mboxes.GetName(i))
    i = i + 1
Wend
System.DebugLog("----")

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