C

Search IMAP Mailbox for Email Matching Criteria

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

#include <C_CkImap.h>
#include <C_CkMessageSet.h>
#include <C_CkEmailBundle.h>
#include <C_CkEmail.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkImap imap;
    BOOL fetchUids;
    const char *allMsgs;
    const char *answered;
    const char *onDate;
    const char *betweenDates;
    const char *complexSearch1;
    const char *bodySearch;
    const char *orSearch;
    const char *fromSearch;
    const char *johnSearch;
    const char *recentSearch;
    const char *notRecentSearch;
    const char *oldSearch;
    const char *markedForDeleteSearch;
    const char *headerSearch;
    const char *headerExistsSearch;
    const char *newSearch;
    const char *sizeLargerSearch;
    const char *seenSearch;
    const char *notSeenSearch;
    const char *toSearch;
    const char *toSearch2;
    const char *smallerSearch;
    const char *fullSubstringSearch;
    HCkMessageSet messageSet;
    HCkEmailBundle bundle;
    BOOL headersOnly;
    HCkEmail email;
    int i;

    success = FALSE;

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

    imap = CkImap_Create();

    // Connect to an IMAP server.
    // Use TLS
    CkImap_putSsl(imap,TRUE);
    CkImap_putPort(imap,993);
    success = CkImap_Connect(imap,"imap.example.com");
    if (success == FALSE) {
        printf("%s\n",CkImap_lastErrorText(imap));
        CkImap_Dispose(imap);
        return;
    }

    // Login
    success = CkImap_Login(imap,"myLogin","myPassword");
    if (success == FALSE) {
        printf("%s\n",CkImap_lastErrorText(imap));
        CkImap_Dispose(imap);
        return;
    }

    // Select an IMAP mailbox
    success = CkImap_SelectMailbox(imap,"Inbox");
    if (success == FALSE) {
        printf("%s\n",CkImap_lastErrorText(imap));
        CkImap_Dispose(imap);
        return;
    }

    // We can choose to fetch UIDs or sequence numbers.
    fetchUids = TRUE;

    // Here are examples of different search criteria:

    // Return all messages.
    allMsgs = "ALL";

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

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

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

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

    // Find emails with the RECENT flag set:
    recentSearch = "RECENT";

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

    // Find all emails marked for deletion:
    markedForDeleteSearch = "DELETED";

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

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

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

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

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

    // Find emails smaller than a size in bytes:
    smallerSearch = "SMALLER 30000";

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

    // Pass any of the above strings here to test a search:
    messageSet = CkMessageSet_Create();
    success = CkImap_QueryMbx(imap,orSearch,fetchUids,messageSet);
    if (success == FALSE) {
        printf("%s\n",CkImap_lastErrorText(imap));
        CkImap_Dispose(imap);
        CkMessageSet_Dispose(messageSet);
        return;
    }

    // Fetch the email headers into a bundle object:
    bundle = CkEmailBundle_Create();
    headersOnly = TRUE;
    success = CkImap_FetchMsgSet(imap,headersOnly,messageSet,bundle);
    if (success == FALSE) {
        printf("%s\n",CkImap_lastErrorText(imap));
        CkImap_Dispose(imap);
        CkMessageSet_Dispose(messageSet);
        CkEmailBundle_Dispose(bundle);
        return;
    }

    // Display the Subject and From of each email.
    email = CkEmail_Create();
    i = 0;
    while (i < CkEmailBundle_getMessageCount(bundle)) {
        CkEmailBundle_EmailAt(bundle,i,email);

        printf("%s\n",CkEmail_getHeaderField(email,"Date"));
        printf("%s\n",CkEmail_subject(email));
        printf("%s\n",CkEmail_ck_from(email));
        printf("--\n");

        i = i + 1;
    }

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


    CkImap_Dispose(imap);
    CkMessageSet_Dispose(messageSet);
    CkEmailBundle_Dispose(bundle);
    CkEmail_Dispose(email);

    }