Lua Requires Chilkat v11.0.0+

Search IMAP Mailbox for Email Matching Criteria

Searching an IMAP mailbox for messages that match search criteria. Lua

    -- In the following call to loadlib, change the path (./chilkat.dll) to the relative or absolute directory where the chilkat.dll, chilkat.so, or chilkat.dylib is located.
    chilkat = assert(package.loadlib("./chilkat.dll", "luaopen_chilkat"))()
    print(chilkat._VERSION)

    local success = false

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

    local imap = chilkat.newImap{}

    --  Connect to an IMAP server.
    --  Use TLS
    imap:setSsl(true)
    imap:setPort(993)
    success = imap:Connect("imap.example.com")
    if success == false then
        print(imap:LastErrorText())

    end

    --  Login
    success = imap:Login("myLogin","myPassword")
    if success == false then
        print(imap:LastErrorText())

    end

    --  Select an IMAP mailbox
    success = imap:SelectMailbox("Inbox")
    if success == false then
        print(imap:LastErrorText())

    end

    --  We can choose to fetch UIDs or sequence numbers.
    local fetchUids = true

    --  Here are examples of different search criteria:

    --  Return all messages.
    local allMsgs = "ALL"

    --  Search for already-answered emails.
    local 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.
    local 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.
    local 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:
    local complexSearch1 = "UNANSWERED SENTSINCE 04-Mar-2007 Subject \"Problem\""

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

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

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

    --  Find emails with the RECENT flag set:
    local recentSearch = "RECENT"

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

    --  Find all emails marked for deletion:
    local markedForDeleteSearch = "DELETED"

    --  Find all emails having a specified header field with a value
    --  containing a substring:
    local 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:
    local headerExistsSearch = "HEADER DomainKey-Signature \"\""

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

    --  Find emails larger than a certain number of bytes:
    local sizeLargerSearch = "LARGER 500000"

    --  Find emails marked as seen or not already seen:
    local seenSearch = "SEEN"
    local notSeenSearch = "NOT SEEN"

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

    --  Find emails smaller than a size in bytes:
    local smallerSearch = "SMALLER 30000"

    --  Find emails that have a substring anywhere in the header
    --  or body:
    local fullSubstringSearch = "TEXT \"Zip Component\""

    --  Pass any of the above strings here to test a search:
    local messageSet = chilkat.newMessageSet{}
    success = imap:QueryMbx(orSearch,fetchUids,messageSet)
    if success == false then
        print(imap:LastErrorText())

    end

    --  Fetch the email headers into a bundle object:
    local bundle = chilkat.newEmailBundle{}
    local headersOnly = true
    success = imap:FetchMsgSet(headersOnly,messageSet,bundle)
    if success == false then
        print(imap:LastErrorText())

    end

    --  Display the Subject and From of each email.
    local email = chilkat.newEmail{}
    local i = 0
    while i < bundle:MessageCount() do
        bundle:EmailAt(i,email)

        print(email:GetHeaderField("Date"))
        print(email:Subject())
        print(email:From())
        print("--")

        i = i + 1
    end

    --  Disconnect from the IMAP server.
    success = imap:Disconnect()