(PowerShell) Fetch 1st N Headers of Search Results

Calls Search to get a message set, then downloads the 1st N messages in the message set. There are two equivalent ways of doing it: (1) iterate from 0 to N-1 and download each message individually, or (2) create a new message set that contains the 1st N messages and pass it to FetchHeaders. Both are demonstrated here.

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

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

# Get the message IDs of all the emails in the mailbox
# We can choose to fetch UIDs or sequence numbers.
$fetchUids = $true
$messageSet = New-Object Chilkat.MessageSet
$success = $imap.QueryMbx("ALL",$fetchUids,$messageSet)
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

$numFound = $messageSet.Count
if ($numFound -eq 0) {
    $("No messages found.")
    exit
}

# Get the 1st 10 messages in messageSet.
$upperBound = 10
if ($numFound -lt $upperBound) {
    $upperBound = $numFound
}

$i = 0
$bUid = $messageSet.HasUids
$headerOnly = $true
$email = New-Object Chilkat.Email

while ($i -lt $upperBound) {

    $success = $imap.FetchEmail($headerOnly,$messageSet.GetId($i),$bUid,$email)
    if ($success -eq $false) {
        $($imap.LastErrorText)
        exit
    }

    $([string]$i + ": " + $email.Subject)

    $i = $i + 1
}

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