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

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

$success = $false

#  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.example.com")
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

#  Login
$success = $imap.Login("myLogin","myPassword")
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

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

$mboxes = New-Object Chilkat.Mailboxes
$success = $imap.MbxList($subscribed,$refName,$wildcardedMailbox,$mboxes)
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

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

$("----")

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

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

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

$("----")

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

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

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

$("----")

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