Tcl

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 Tcl Downloads

Download Chilkat for Tcl

Tcl


load ./chilkat.dll

set success 0

#  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.

set imap [new_CkImap]

CkImap_put_Ssl $imap 1
CkImap_put_Port $imap 993

set success [CkImap_Connect $imap "imap.example.com"]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

set success [CkImap_Login $imap "user@example.com" "myPassword"]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

set success [CkImap_SelectMailbox $imap "Inbox"]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    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.
set headersOnly 1
set useUid 0
set seqNum 1
set email [new_CkEmail]

set success [CkImap_FetchEmail $imap $headersOnly $seqNum $useUid $email]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    delete_CkEmail $email
    exit
}

set numAttach [CkImap_GetMailNumAttach $imap $email]
if {$numAttach > 0} then {
    #  Download just the first attachment's bytes from the server into a BinData.
    set bd [new_CkBinData]

    set success [CkImap_FetchAttachmentBd $imap $email 0 $bd]
    if {$success == 0} then {
        puts [CkImap_lastErrorText $imap]
        delete_CkImap $imap
        delete_CkEmail $email
        delete_CkBinData $bd
        exit
    }

    puts "Attachment size: [CkBinData_get_NumBytes $bd] bytes"
}

set success [CkImap_Disconnect $imap]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    delete_CkEmail $email
    delete_CkBinData $bd
    exit
}


delete_CkImap $imap
delete_CkEmail $email
delete_CkBinData $bd