(Tcl) Read IMAP Email Headers

Call FetchHeaders to download only the email headers.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set imap [new_CkImap]

# Connect to an IMAP server.
# Use TLS
CkImap_put_Ssl $imap 1
CkImap_put_Port $imap 993
set success [CkImap_Connect $imap "imap.someMailServer.com"]
if {[expr $success != 1]} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

# Login
set success [CkImap_Login $imap "****" "****"]
if {[expr $success != 1]} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

# Select an IMAP mailbox
set success [CkImap_SelectMailbox $imap "Inbox"]
if {[expr $success != 1]} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

# messageSet is a CkMessageSet

# We can choose to fetch UIDs or sequence numbers.
set fetchUids 1
# Get the message IDs of all the emails in the mailbox
set messageSet [CkImap_Search $imap "ALL" $fetchUids]
if {[expr [CkImap_get_LastMethodSuccess $imap] != 1]} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

# When downloading headers, each email object contains
# (obviously) the headers, but the body will be missing.
# Also, attachments will not be included.  However, it is
# possible to get information about the attachments
# as well as the complete size of the email.
# bundle is a CkEmailBundle

set bundle [CkImap_FetchHeaders $imap $messageSet]
if {[expr [CkImap_get_LastMethodSuccess $imap] != 1]} then {
    delete_CkMessageSet $messageSet

    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

# Loop over the email objects and display information
# about each:

for {set i 0} {$i <= [expr [CkEmailBundle_get_MessageCount $bundle] - 1]} {incr i} {
    # email is a CkEmail

    set email [CkEmailBundle_GetEmail $bundle $i]

    # Display the From and Subject
    puts [CkEmail_from $email]
    puts [CkEmail_subject $email]

    # Display the recipients:

    for {set j 0} {$j <= [expr [CkEmail_get_NumTo $email] - 1]} {incr j} {
        set name [CkEmail_getToName $email $j]
        set addr [CkEmail_getToAddr $email $j]
        puts "$name, $addr"
    }
    for {set j 0} {$j <= [expr [CkEmail_get_NumCC $email] - 1]} {incr j} {
        set name [CkEmail_getCcName $email $j]
        set addr [CkEmail_getCcAddr $email $j]
        puts "$name, $addr"
    }

    # Show the total size of the email, including body and attachments:
    puts [CkEmail_get_Size $email]

    # When a full email is downloaded, we would use the
    # email.NumAttachments property in conjunction with the
    # email.GetMailAttach* methods.
    # However, when an email object contains only the header,
    # we need to access the attachment info differently:
    set numAttach [CkImap_GetMailNumAttach $imap $email]
    for {set j 0} {$j <= [expr $numAttach - 1]} {incr j} {
        puts [CkImap_getMailAttachFilename $imap $email $j]
        set attachSize [CkImap_GetMailAttachSize $imap $email $j]
        puts "    size = $attachSize bytes"
    }

    puts "--"
    delete_CkEmail $email

}

# Disconnect from the IMAP server.
set success [CkImap_Disconnect $imap]

delete_CkMessageSet $messageSet

delete_CkEmailBundle $bundle


delete_CkImap $imap