(PowerShell) IMAP Delete Old Email (before a specified date)

Demonstrates how to delete email older than a particular date.

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
# Use your IMAP server domain.  This example 
$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
}

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

# Get message ID's for emails older than 1/1/2025
$fetchUids = $true
$messageSet = New-Object Chilkat.MessageSet
$success = $imap.QueryMbx("SENTBEFORE 01-Jan-2025",$fetchUids,$messageSet)
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

# If desired, we can examine the Subject of each email to be deleted..
$email = New-Object Chilkat.Email
$i = 0
$count = $messageSet.Count
$headerOnly = $true

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

    $($email.LocalDateStr)
    $($email.Subject)

    $i = $i + 1
}

# Set the Deleted flag for each message:
$success = $imap.SetFlags($messageSet,"Deleted",1)
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

# Expunge and close the mailbox.
$success = $imap.ExpungeAndClose()
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

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