(Swift 3,4,5...) Search IMAP Mailbox for Email Matching Criteria

Searching an IMAP mailbox for messages that match search criteria.

Chilkat Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

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

    let imap = CkoImap()!

    // Connect to an IMAP server.
    // Use TLS
    imap.ssl = true
    imap.port = 993
    var success: Bool = imap.connect("imap.someMailServer.com")
    if success != true {
        print("\(imap.lastErrorText!)")
        return
    }

    // Login
    success = imap.login("myLogin", password: "myPassword")
    if success != true {
        print("\(imap.lastErrorText!)")
        return
    }

    // Select an IMAP mailbox
    success = imap.selectMailbox("Inbox")
    if success != true {
        print("\(imap.lastErrorText!)")
        return
    }

    var messageSet: CkoMessageSet?
    // We can choose to fetch UIDs or sequence numbers.
    var fetchUids: Bool = true

    // Here are examples of different search criteria:

    // Return all messages.
    var allMsgs: String? = "ALL"

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

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

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

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

    // Find emails with the RECENT flag set:
    var recentSearch: String? = "RECENT"

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

    // Find all emails marked for deletion:
    var markedForDeleteSearch: String? = "DELETED"

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

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

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

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

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

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

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

    // Pass any of the above strings here to test a search:
    messageSet = imap.search(orSearch, bUid: fetchUids)
    if imap.lastMethodSuccess == false {
        print("\(imap.lastErrorText!)")
        return
    }

    // Fetch the email headers into a bundle object:
    var bundle: CkoEmailBundle?
    bundle = imap.fetchHeaders(messageSet)
    if imap.lastMethodSuccess == false {
        messageSet = nil
        print("\(imap.lastErrorText!)")
        return
    }

    // Display the Subject and From of each email.
    var i: Int = 0
    while i < bundle!.messageCount.intValue {
        var email: CkoEmail?
        email = bundle!.getEmail(i)

        print("\(email!.getHeaderField("Date")!)")
        print("\(email!.subject!)")
        print("\(email!.from!)")
        print("--")

        email = nil

        i = i + 1
    }

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

    messageSet = nil
    bundle = nil

}