(PowerShell) 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 Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$imap = New-Object Chilkat.Imap

# Connect to an IMAP server.
# Use TLS
$imap.Ssl = $true
$imap.Port = 993
$success = $imap.Connect("imap.someMailServer.com")
if ($success -ne $true) {
    $($imap.LastErrorText)
    exit
}

# Login
$success = $imap.Login("admin@chilkatsoft.com","myPassword")
if ($success -ne $true) {
    $($imap.LastErrorText)
    exit
}

# 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
$refName = "INBOX.vendors"

# Select all mailboxes matching this pattern:
$wildcardedMailbox = "*"

$mboxes = $imap.ListMailboxes($refName,$wildcardedMailbox)
if ($imap.LastMethodSuccess -eq $false) {
    $($imap.LastErrorText)
    exit
}

$i = 0
while ($i -lt $mboxes.Count) {
    $($mboxes.GetName($i))
    $i = $i + 1
}

# 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()