(Tcl) Search IMAP Mailbox for Email Matching Criteria

Searching an IMAP mailbox for messages that match search criteria.

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

# Login
set success [CkImap_Login $imap "myLogin" "myPassword"]
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

# Here are examples of different search criteria:

# Return all messages.
set allMsgs "ALL"

# Search for already-answered emails.
set answered "ANSWERED"

# Search for messages on a specific date.
# The date string is DD-Month-YYYY where Month is
# Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, or Dec.
set onDate "SENTON 05-Mar-2007"

# Search for messages between two dates.  SENTBEFORE
# finds emails sent before a date, and SENTSINCE finds
# email sent on or after a date.  The "AND" operation
# is implied by joining criteria, separated by spaces.
set betweenDates "SENTSINCE 01-Mar-2007 SENTBEFORE 05-Mar-2007"

# Another example of AND: find all unanswered emails
# sent after 04-Mar-2007 with "Problem" in the subject:
set complexSearch1 "UNANSWERED SENTSINCE 04-Mar-2007 Subject \"Problem\""

# Find messages with a specific string in the body:
set bodySearch "BODY \"problem solved\""

# Using OR.  The syntax is OR <criteria1> <criteria2>. 
# The "OR" comes first, followed by each criteria.
# For example, to match all emails with "Help" or "Question" in the subject.
# You'll notice that literal strings may be quoted or unquoted.
# If a literal contains SPACE characters, quote it:
set orSearch "OR SUBJECT Help SUBJECT Question"

# ----------------------------------------------
# Strings are case-insensitive when searching....
# ----------------------------------------------

# Find all emails sent from yahoo.com addresses:
set fromSearch "FROM yahoo.com"
# Find all emails sent from anyone with "John" in their name:
set johnSearch "FROM John"

# Find emails with the RECENT flag set:
set recentSearch "RECENT"

# Find emails that don't have the recent flag set:
set notRecentSearch "NOT RECENT"
# This is synonymous with "OLD":
set oldSearch "OLD"

# Find all emails marked for deletion:
set markedForDeleteSearch "DELETED"

# Find all emails having a specified header field with a value
# containing a substring:
set headerSearch "HEADER DomainKey-Signature paypal.com"

# Find any emails having a specific header field.  If the 
# 2nd argument to the "HEADER" criteria is an empty string,
# any email having the header field is returned regardless
# of the header field's content.
# Find any emails with a DomainKey-Signature field:
set headerExistsSearch "HEADER DomainKey-Signature \"\""

# Find NEW emails: these are emails that have the RECENT flag
# set, but not the SEEN flag:
set newSearch "NEW"

# Find emails larger than a certain number of bytes:
set sizeLargerSearch "LARGER 500000"

# Find emails marked as seen or not already seen:
set seenSearch "SEEN"
set notSeenSearch "NOT SEEN"

# Find emails having a given substring in the TO header field:
set toSearch "TO support@chilkatsoft.com"
# A more long-winded way to do the same thing:
set toSearch2 "HEADER TO support@chilkatsoft.com"

# Find emails smaller than a size in bytes:
set smallerSearch "SMALLER 30000"

# Find emails that have a substring anywhere in the header
# or body:
set fullSubstringSearch "TEXT \"Zip Component\""

# Pass any of the above strings here to test a search:
set messageSet [CkImap_Search $imap $orSearch $fetchUids]
if {[CkImap_get_LastMethodSuccess $imap] == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

# Fetch the email headers into a bundle object:
# bundle is a CkEmailBundle

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

    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

# Display the Subject and From of each email.
set i 0
while {$i < [CkEmailBundle_get_MessageCount $bundle]} {
    # email is a CkEmail

    set email [CkEmailBundle_GetEmail $bundle $i]

    puts [CkEmail_getHeaderField $email Date]
    puts [CkEmail_subject $email]
    puts [CkEmail_from $email]
    puts "--"

    delete_CkEmail $email

    set i [expr $i + 1]
}

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

delete_CkMessageSet $messageSet

delete_CkEmailBundle $bundle


delete_CkImap $imap