Tcl

Fetch Full Email Given Email Header

When you fetch email headers using UIDs instead of sequence numbers, the email object (which includes only the header) will have auto-generated ckx-imap-* headers. These headers provide details like the UID and attachments. The IMAP UID is found in the ckx-imap-uid header. Additionally, the ckx-imap-isUid header indicates whether the email header was downloaded by UID, showing YES or NO. Since sequence numbers can change if emails are deleted, UIDs are essential for downloading the correct full email.

The Chilkat Email object offers a GetImapUid method to retrieve the UID from the ckx-imap-uid header. This UID can be used to fetch the full email.

Tcl

load ./chilkat.dll

set success 0

# 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.example.com"]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

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

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

set emailHeader [new_CkEmail]

set emailFull [new_CkEmail]

set uid 2014
set isUid 1

# Fetch only the email header
set success [CkImap_FetchEmail $imap 1 $uid $isUid $emailHeader]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    delete_CkEmail $emailHeader
    delete_CkEmail $emailFull
    exit
}

# Now fetch the full email
set uidFromCkxHeader [CkEmail_GetImapUid $emailHeader]
if {$uidFromCkxHeader < 0} then {
    # Failed. 
    puts "No ckx-imap-uid header was found."
    delete_CkImap $imap
    delete_CkEmail $emailHeader
    delete_CkEmail $emailFull
    exit
}

set success [CkImap_FetchEmail $imap 0 $uid $isUid $emailFull]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    delete_CkEmail $emailHeader
    delete_CkEmail $emailFull
    exit
}

# OK, we have the full email, do whatever we want...

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

delete_CkImap $imap
delete_CkEmail $emailHeader
delete_CkEmail $emailFull