(PowerShell) How to Download Messages in MessageSet One at a Time

If a message set contains a huge number of emails, it's NOT a good idea to try to download all at once into an email bundle using a method such as FetchBundle. It's better to iterate over the messages in the set to download one by one.

Note: This example requires Chilkat v11.0.0 or greater.

Chilkat .NET Downloads Chilkat .NET Assemblies

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

$success = $false

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

$imap = New-Object Chilkat.Imap

# Connect using TLS.
$imap.Ssl = $true
$imap.Port = 993
$success = $imap.Connect("imap.example.com")
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

# Authenticate
$success = $imap.Login("email_account_login","email_account_password")
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

# Select an IMAP mailbox
$success = $imap.SelectMailbox("Inbox")
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

# Search for messages and return a set of matching messages.
# (This example will simply search for ALL messages.)
$fetchUids = $true

$messageSet = New-Object Chilkat.MessageSet
$success = $imap.QueryMbx("ALL",$fetchUids,$messageSet)
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

$("Number of messages = " + $messageSet.Count)

$email = New-Object Chilkat.Email
$i = 0
while ($i -lt $messageSet.Count) {
    $success = $imap.FetchEmail($false,$messageSet.GetId($i),$fetchUids,$email)
    if ($success -eq $false) {
        $($imap.LastErrorText)
        exit
    }

    $($email.From + "; " + $email.Subject)

    $i = $i + 1
}

$("OK")