(Tcl) Transition from Imap.Sort to Imap.QueryMbx

Provides instructions for replacing deprecated Sort method calls with QueryMbx.

Note: This example requires Chilkat v11.0.0 or greater.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

set imap [new_CkImap]

# ...
# ...

set searchCriteria "FROM bob@example.com"
set bUid 1
set sortCriteria "DATE SUBJECT"

# ------------------------------------------------------------------------
# The Sort method is deprecated:

# msgSetObj is a CkMessageSet
set msgSetObj [CkImap_Sort $imap $sortCriteria "utf-8" $searchCriteria $bUid]
if {[CkImap_get_LastMethodSuccess $imap] == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

# ...
# ...

delete_CkMessageSet $msgSetObj

# ------------------------------------------------------------------------
# Do the equivalent using QueryMbx.
# Your application creates a new, empty MessageSet object which is passed 
# in the last argument and filled upon success.

# The following properties are used instead of function arguments.
CkImap_put_SortCriteria $imap "DATE SUBJECT"
CkImap_put_SearchCharset $imap "utf-8"

set mset [new_CkMessageSet]

set success [CkImap_QueryMbx $imap $searchCriteria $bUid $mset]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    delete_CkMessageSet $mset
    exit
}


delete_CkImap $imap
delete_CkMessageSet $mset