(Xojo Plugin) Search IMAP Mailbox for Email Matching Criteria

Searching an IMAP mailbox for messages that match search criteria.

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

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

Dim imap As New Chilkat.Imap

// Connect to an IMAP server.
// Use TLS
imap.Ssl = True
imap.Port = 993
Dim success As Boolean
success = imap.Connect("imap.someMailServer.com")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Login
success = imap.Login("myLogin","myPassword")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Select an IMAP mailbox
success = imap.SelectMailbox("Inbox")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

Dim messageSet As Chilkat.MessageSet
// We can choose to fetch UIDs or sequence numbers.
Dim fetchUids As Boolean
fetchUids = True

// Here are examples of different search criteria:

// Return all messages.
Dim allMsgs As String
allMsgs = "ALL"

// Search for already-answered emails.
Dim answered As String
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.
Dim onDate As String
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.
Dim betweenDates As String
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:
Dim complexSearch1 As String
complexSearch1 = "UNANSWERED SENTSINCE 04-Mar-2007 Subject ""Problem"""

// Find messages with a specific string in the body:
Dim bodySearch As String
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:
Dim orSearch As String
orSearch = "OR SUBJECT Help SUBJECT Question"

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

// Find all emails sent from yahoo.com addresses:
Dim fromSearch As String
fromSearch = "FROM yahoo.com"
// Find all emails sent from anyone with "John" in their name:
Dim johnSearch As String
johnSearch = "FROM John"

// Find emails with the RECENT flag set:
Dim recentSearch As String
recentSearch = "RECENT"

// Find emails that don't have the recent flag set:
Dim notRecentSearch As String
notRecentSearch = "NOT RECENT"
// This is synonymous with "OLD":
Dim oldSearch As String
oldSearch = "OLD"

// Find all emails marked for deletion:
Dim markedForDeleteSearch As String
markedForDeleteSearch = "DELETED"

// Find all emails having a specified header field with a value
// containing a substring:
Dim headerSearch As String
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:
Dim headerExistsSearch As String
headerExistsSearch = "HEADER DomainKey-Signature """""

// Find NEW emails: these are emails that have the RECENT flag
// set, but not the SEEN flag:
Dim newSearch As String
newSearch = "NEW"

// Find emails larger than a certain number of bytes:
Dim sizeLargerSearch As String
sizeLargerSearch = "LARGER 500000"

// Find emails marked as seen or not already seen:
Dim seenSearch As String
seenSearch = "SEEN"
Dim notSeenSearch As String
notSeenSearch = "NOT SEEN"

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

// Find emails smaller than a size in bytes:
Dim smallerSearch As String
smallerSearch = "SMALLER 30000"

// Find emails that have a substring anywhere in the header
// or body:
Dim fullSubstringSearch As String
fullSubstringSearch = "TEXT ""Zip Component"""

// Pass any of the above strings here to test a search:
messageSet = imap.Search(orSearch,fetchUids)
If (imap.LastMethodSuccess = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Fetch the email headers into a bundle object:
Dim bundle As Chilkat.EmailBundle
bundle = imap.FetchHeaders(messageSet)
If (imap.LastMethodSuccess = False) Then

    System.DebugLog(imap.LastErrorText)
    Return
End If

// Display the Subject and From of each email.
Dim i As Int32
i = 0
While i < bundle.MessageCount
    Dim email As Chilkat.Email
    email = bundle.GetEmail(i)

    System.DebugLog(email.GetHeaderField("Date"))
    System.DebugLog(email.Subject)
    System.DebugLog(email.From)
    System.DebugLog("--")

    i = i + 1
Wend

// Disconnect from the IMAP server.
success = imap.Disconnect()