PowerShell

Fetch a Text IMAP Attachment as a String

Demonstrates the Chilkat Imap.FetchAttachmentString method, which returns one text attachment decoded to a string. The first argument is the Email, the second is the zero-based attachment index, and the third is the charset used to decode the bytes. This example returns the first attachment as a UTF-8 string.

Background: This is the convenient form when you simply want a small text attachment's content inline as a string. Only use it for attachments known to be text; decoding binary content through a charset can alter or corrupt the bytes. For binary data use FetchAttachmentBd, and for large text a StringBuilder (via FetchAttachmentSb) avoids an extra copy.

Chilkat PowerShell Downloads

Download Chilkat for PowerShell

PowerShell

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

$success = $false

#  Demonstrates the Imap.FetchAttachmentString method, which downloads one text attachment and
#  returns it decoded to a string.  The 1st argument is the Email, the 2nd is the zero-based
#  attachment index, and the 3rd is the charset used to decode the bytes.
#  
#  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) {
    #  FetchAttachmentString returns a string, so assign it to a string variable.
    $attachText = $imap.FetchAttachmentString($email,0,"utf-8")
    if ($imap.LastMethodSuccess -eq $false) {
        $($imap.LastErrorText)
        exit
    }

    $($attachText)
}

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