B4X 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. B4X

Dim success As Boolean = False

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

Dim imap As ChilkatImap
imap.Initialize("imap")

'  Connect to an IMAP server.
'  Use TLS
imap.Ssl = True
imap.Port = 993
success = imap.Connect("imap.example.com")
If success = False Then
    Log(imap.LastErrorText)
    Return
End If


'  Login
success = imap.Login("myLogin", "myPassword")
If success = False Then
    Log(imap.LastErrorText)
    Return
End If


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

Dim mboxes As ChilkatMailboxes
mboxes.Initialize
success = imap.MbxList(subscribed, refName, wildcardedMailbox, mboxes)
If success = False Then
    Log(imap.LastErrorText)
    Return
End If


Dim i As Int = 0
Do While i < mboxes.Count
    Log(mboxes.GetName(i))
    i = i + 1
Loop
Log("----")

'  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
    Log(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
    Log(imap.LastErrorText)
    Return
End If


i = 0
Do While i < mboxes.Count
    Log(mboxes.GetName(i))
    i = i + 1
Loop
Log("----")

'  Re-subscribe to "INBOX/misc/solutions".
success = imap.Subscribe("INBOX/misc/solutions")
If success = False Then
    Log(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
    Log(imap.LastErrorText)
    Return
End If


i = 0
Do While i < mboxes.Count
    Log(mboxes.GetName(i))
    i = i + 1
Loop
Log("----")

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