(PowerShell) Subscribe to Mailboxes and List Subscribed Mailboxes

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

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("myLogin","myPassword")
if ($success -ne $true) {
    $($imap.LastErrorText)
    exit
}

# First examine the already subscribed mailboxes.
$refName = ""
$wildcardedMailbox = "*"

# Alternatively, the ListMailboxes method can be called to list all mailboxes (both subscribed and unsubscribed).
$mboxes = $imap.ListSubscribed($refName,$wildcardedMailbox)
if ($imap.LastMethodSuccess -ne $true) {
    $($imap.LastErrorText)
    exit
}

for ($i = 0; $i -le $mboxes.Count - 1; $i++) {
    $($mboxes.GetName($i))
}

$("----")

# 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 -ne $true) {
    $($imap.LastErrorText)
    exit
}

# Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is missing.
$mboxes = $imap.ListSubscribed("","INBOX/misc*")
if ($imap.LastMethodSuccess -ne $true) {
    $($imap.LastErrorText)
    exit
}

for ($i = 0; $i -le $mboxes.Count - 1; $i++) {
    $($mboxes.GetName($i))
}

$("----")

# Re-subscribe to "INBOX/misc/solutions".
$success = $imap.Subscribe("INBOX/misc/solutions")
if ($success -ne $true) {
    $($imap.LastErrorText)
    exit
}

# Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is back in the list.
$mboxes = $imap.ListSubscribed("","INBOX/misc*")
if ($imap.LastMethodSuccess -ne $true) {
    $($imap.LastErrorText)
    exit
}

for ($i = 0; $i -le $mboxes.Count - 1; $i++) {
    $($mboxes.GetName($i))
}

$("----")

# Disconnect from the IMAP server.
$success = $imap.Disconnect()