(Tcl) Fetch 1st N Headers of Search Results

Calls Search to get a message set, then downloads the 1st N messages in the message set. There are two equivalent ways of doing it: (1) iterate from 0 to N-1 and download each message individually, or (2) create a new message set that contains the 1st N messages and pass it to FetchHeaders. Both are demonstrated here.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# This example assumes 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 {$success != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

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

# Select an IMAP mailbox
set success [CkImap_SelectMailbox $imap "Inbox"]
if {$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 {[CkImap_get_LastMethodSuccess $imap] == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

set numFound [CkMessageSet_get_Count $messageSet]
if {$numFound == 0} then {
    puts "No messages found."
    delete_CkMessageSet $messageSet

    delete_CkImap $imap
    exit
}

# Get the 1st 10 messages in messageSet.
set upperBound 10
if {$numFound < $upperBound} then {
    set upperBound $numFound
}

set i 0
set bUid [CkMessageSet_get_HasUids $messageSet]
while {$i < $upperBound} {

    # email is a CkEmail
    set email [CkImap_FetchSingleHeader $imap [CkMessageSet_GetId $messageSet $i] $bUid]
    if {[CkImap_get_LastMethodSuccess $imap] == 0} then {
        puts [CkImap_lastErrorText $imap]
        delete_CkMessageSet $messageSet

        delete_CkImap $imap
        exit

    }     else {
        # Do whatever is needed with the email.. 
        # ....

        delete_CkEmail $email

    }

    set i [expr $i + 1]
}

# Alternatively, create a new message set containing the 1st 10 message id's (UID's) 
# from the search results message set:
set firstTen [new_CkMessageSet]

for {set i 0} {$i <= [expr $upperBound - 1]} {incr i} {
    CkMessageSet_InsertId $firstTen [CkMessageSet_GetId $messageSet $i]
}

delete_CkMessageSet $messageSet

# Download the 1st ten headers:
# bundle is a CkEmailBundle

set bundle [CkImap_FetchHeaders $imap $firstTen]
if {[CkImap_get_LastMethodSuccess $imap] == 0} then {
    delete_CkMessageSet $firstTen

    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    delete_CkMessageSet $firstTen
    exit
}

# Other examples show how to iterate over the emails contained within the bundle...

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

delete_CkMessageSet $firstTen

delete_CkEmailBundle $bundle


delete_CkImap $imap
delete_CkMessageSet $firstTen