(PowerBuilder) Search IMAP Mailbox for Email Matching Criteria

Searching an IMAP mailbox for messages that match search criteria.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_Imap
integer li_Success
oleobject loo_MessageSet
integer li_FetchUids
string ls_AllMsgs
string ls_Answered
string ls_OnDate
string ls_BetweenDates
string ls_ComplexSearch1
string ls_BodySearch
string ls_OrSearch
string ls_FromSearch
string ls_JohnSearch
string ls_RecentSearch
string ls_NotRecentSearch
string ls_OldSearch
string ls_MarkedForDeleteSearch
string ls_HeaderSearch
string ls_HeaderExistsSearch
string ls_NewSearch
string ls_SizeLargerSearch
string ls_SeenSearch
string ls_NotSeenSearch
string ls_ToSearch
string ls_ToSearch2
string ls_SmallerSearch
string ls_FullSubstringSearch
oleobject loo_Bundle
integer i
oleobject loo_Email

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

loo_Imap = create oleobject
// Use "Chilkat_9_5_0.Imap" for versions of Chilkat < 10.0.0
li_rc = loo_Imap.ConnectToNewObject("Chilkat.Imap")
if li_rc < 0 then
    destroy loo_Imap
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Connect to an IMAP server.
// Use TLS
loo_Imap.Ssl = 1
loo_Imap.Port = 993
li_Success = loo_Imap.Connect("imap.someMailServer.com")
if li_Success <> 1 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    return
end if

// Login
li_Success = loo_Imap.Login("myLogin","myPassword")
if li_Success <> 1 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    return
end if

// Select an IMAP mailbox
li_Success = loo_Imap.SelectMailbox("Inbox")
if li_Success <> 1 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    return
end if

// We can choose to fetch UIDs or sequence numbers.
li_FetchUids = 1

// Here are examples of different search criteria:

// Return all messages.
ls_AllMsgs = "ALL"

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

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

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

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

// Find emails with the RECENT flag set:
ls_RecentSearch = "RECENT"

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

// Find all emails marked for deletion:
ls_MarkedForDeleteSearch = "DELETED"

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

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

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

// Find emails marked as seen or not already seen:
ls_SeenSearch = "SEEN"
ls_NotSeenSearch = "NOT SEEN"

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

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

// Find emails that have a substring anywhere in the header
// or body:
ls_FullSubstringSearch = "TEXT ~"Zip Component~""

// Pass any of the above strings here to test a search:
loo_MessageSet = loo_Imap.Search(ls_OrSearch,li_FetchUids)
if loo_Imap.LastMethodSuccess = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    return
end if

// Fetch the email headers into a bundle object:

loo_Bundle = loo_Imap.FetchHeaders(loo_MessageSet)
if loo_Imap.LastMethodSuccess = 0 then
    destroy loo_MessageSet
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    return
end if

// Display the Subject and From of each email.
i = 0
do while i < loo_Bundle.MessageCount

    loo_Email = loo_Bundle.GetEmail(i)

    Write-Debug loo_Email.GetHeaderField("Date")
    Write-Debug loo_Email.Subject
    Write-Debug loo_Email.From
    Write-Debug "--"

    destroy loo_Email

    i = i + 1
loop

// Disconnect from the IMAP server.
li_Success = loo_Imap.Disconnect()

destroy loo_MessageSet
destroy loo_Bundle


destroy loo_Imap