PowerShell

Get IMAP UID from Email Header

See more IMAP Examples

Demonstrates how to get the IMAP UID from an email header. After fetching an email or header using IMAP, the UID is contained in the ckx-imap-uid header field. PowerShell

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

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

$fetchUids = $true
# Get the message UIDs of all the emails in the mailbox

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

$bundle = New-Object Chilkat.EmailBundle
$headersOnly = $true
$success = $imap.FetchMsgSet($headersOnly,$messageSet,$bundle)
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

# The UID of each fetched email header is available 
# in the ckx-imap-uid header field.
$email = New-Object Chilkat.Email
$msgSet1 = New-Object Chilkat.MessageSet
$i = 0
$szBundle = $bundle.MessageCount
while ($i -lt $szBundle) {
    $bundle.EmailAt($i,$email)

    # Build a message set containing one UID
    $uidStr = $email.GetHeaderField("ckx-imap-uid")
    $msgSet1.FromCompactString($uidStr)

    # Move this message to some other folder.
    $success = $imap.MoveMessages($msgSet1,"someOtherFolder")
    if ($success -ne $true) {
        $($imap.LastErrorText)
        # Exit the loop...
        $i = $szBundle
    }

    $i = $i + 1
}

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