(Excel) Subscribe to Mailboxes and List Subscribed Mailboxes

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

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim imap As Chilkat.Imap
Set imap = Chilkat.NewImap

' Connect to an IMAP server.
' Use TLS
imap.Ssl = True
imap.Port = 993

success = imap.Connect("imap.someMailServer.com")
If (success <> True) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

' Login
success = imap.Login("myLogin","myPassword")
If (success <> True) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

' First examine the already subscribed mailboxes.

refName = ""

wildcardedMailbox = "*"

' Alternatively, the ListMailboxes method can be called to list all mailboxes (both subscribed and unsubscribed).

Set mboxes = imap.ListSubscribed(refName,wildcardedMailbox)
If (imap.LastMethodSuccess <> True) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

For i = 0 To mboxes.Count - 1
    Debug.Print mboxes.GetName(i)
Next
Debug.Print "----"

' 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
    Debug.Print imap.LastErrorText
    Exit Sub
End If

' Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is missing.
Set mboxes = imap.ListSubscribed("","INBOX/misc*")
If (imap.LastMethodSuccess <> True) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

For i = 0 To mboxes.Count - 1
    Debug.Print mboxes.GetName(i)
Next

Debug.Print "----"

' Re-subscribe to "INBOX/misc/solutions".
success = imap.Subscribe("INBOX/misc/solutions")
If (success <> True) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

' Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is back in the list.
Set mboxes = imap.ListSubscribed("","INBOX/misc*")
If (imap.LastMethodSuccess <> True) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

For i = 0 To mboxes.Count - 1
    Debug.Print mboxes.GetName(i)
Next

Debug.Print "----"

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