Tcl

Fetch a Text IMAP Attachment into a StringBuilder

Demonstrates the Chilkat Imap.FetchAttachmentSb method, which decodes one text attachment into a StringBuilder. The first argument is the Email, the second is the zero-based attachment index, the third is the charset used to decode the bytes, and the fourth is the StringBuilder, which is cleared first. This example decodes the first attachment as UTF-8.

Background: For text attachments — a CSV, a .txt, an XML file — decoding straight to characters saves a manual charset step. The charset argument names the encoding of the attachment bytes (for example utf-8 or iso-8859-1). For binary attachments, use FetchAttachmentBd instead, since forcing binary through a text decoder can corrupt it.

Chilkat Tcl Downloads

Download Chilkat for Tcl

Tcl


load ./chilkat.dll

set success 0

#  Demonstrates the Imap.FetchAttachmentSb method, which downloads one text attachment and
#  decodes it into a StringBuilder.  The 1st argument is the Email, the 2nd is the zero-based
#  attachment index, the 3rd is the charset used to decode, and the 4th is the StringBuilder
#  (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 the first (text) attachment and decode it as UTF-8.  Use this only for text.
    set sb [new_CkStringBuilder]

    set success [CkImap_FetchAttachmentSb $imap $email 0 "utf-8" $sb]
    if {$success == 0} then {
        puts [CkImap_lastErrorText $imap]
        delete_CkImap $imap
        delete_CkEmail $email
        delete_CkStringBuilder $sb
        exit
    }

    set attachText [CkStringBuilder_getAsString $sb]
    puts "$attachText"
}

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


delete_CkImap $imap
delete_CkEmail $email
delete_CkStringBuilder $sb