(VB.NET) List IMAP Mailboxes with Reference

Demonstrates how to list all sub-mailboxes within a specified context. In this case, we list all mailboxes under "INBOX.vendors".

Chilkat .NET Downloads Chilkat .NET Framework Chilkat for .NET Core

' 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 = imap.Connect("imap.someMailServer.com")
If (success <> True) Then
    Debug.WriteLine(imap.LastErrorText)
    Exit Sub
End If


' Login
success = imap.Login("admin@chilkatsoft.com","myPassword")
If (success <> True) Then
    Debug.WriteLine(imap.LastErrorText)
    Exit Sub
End If


' The ListMailboxes method returns a Mailboxes object
' that contains the collection of mailboxes.
' It accepts two arguments: a refName and a wildcardedMailbox.

' List all mailboxes under INBOX.vendors
Dim refName As String = "INBOX.vendors"

' Select all mailboxes matching this pattern:
Dim wildcardedMailbox As String = "*"

Dim mboxes As Chilkat.Mailboxes = imap.ListMailboxes(refName,wildcardedMailbox)
If (imap.LastMethodSuccess = False) Then
    Debug.WriteLine(imap.LastErrorText)
    Exit Sub
End If


Dim i As Integer = 0
While i < mboxes.Count
    Debug.WriteLine(mboxes.GetName(i))
    i = i + 1
End While

' Sample output looks like this:
' INBOX.vendors.shareit
' INBOX.vendors.paypal
' INBOX.vendors.dell
' INBOX.vendors.inMotion
' INBOX.vendors.myhosting
' INBOX.vendors.peer1

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