PowerShell

Fetch an IMAP Attachment into a BinData

Demonstrates the Chilkat Imap.FetchAttachmentBd method, which stores one attachment's bytes in a BinData object. The first argument is the Email, the second is the zero-based attachment index, and the third is the BinData, which is cleared before the operation. This example fetches the first attachment and prints its byte count.

Background: A BinData holds raw bytes, so it works for any attachment type — image, PDF, zip, and so on. From there you can save it, hash it, or hand it to another API expecting a byte buffer, all without touching the filesystem. Use the string/StringBuilder variants only when the attachment is known to be text.

Chilkat PowerShell Downloads

Download Chilkat for PowerShell

PowerShell

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

$success = $false

#  Demonstrates the Imap.FetchAttachmentBd method, which downloads one attachment's bytes into
#  a BinData object.  The 1st argument is the Email, the 2nd is the zero-based attachment
#  index, and the 3rd is the BinData (which is cleared first).
#  
#  The message is fetched headers-only, then the attachment is downloaded on demand.

$imap = New-Object Chilkat.Imap

$imap.Ssl = $true
$imap.Port = 993

$success = $imap.Connect("imap.example.com")
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

$success = $imap.Login("user@example.com","myPassword")
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

$success = $imap.SelectMailbox("Inbox")
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

#  Fetch only the message headers.  Attachment bodies are NOT downloaded, but the ckx-imap-*
#  metadata describing the attachments is present, so the attachment info methods still work.
$headersOnly = $true
$useUid = $false
$seqNum = 1
$email = New-Object Chilkat.Email
$success = $imap.FetchEmail($headersOnly,$seqNum,$useUid,$email)
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

$numAttach = $imap.GetMailNumAttach($email)
if ($numAttach -gt 0) {
    #  Download just the first attachment's bytes from the server into a BinData.
    $bd = New-Object Chilkat.BinData
    $success = $imap.FetchAttachmentBd($email,0,$bd)
    if ($success -eq $false) {
        $($imap.LastErrorText)
        exit
    }

    $("Attachment size: " + $bd.NumBytes + " bytes")
}

$success = $imap.Disconnect()
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}