Xbase++ Requires Chilkat v11.0.0+

Download an IMAP Message Set

Demonstrates how to read a set of IMAP emails. Xbase++

LOCAL nSuccess
LOCAL oImap
LOCAL nFetchUids
LOCAL oMessageSet
LOCAL oBundle
LOCAL nHeadersOnly
LOCAL oEmail
LOCAL i
LOCAL nNumEmails

nSuccess := 0

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

oImap := CreateObject("Chilkat.Imap")

//  Connect using TLS.
oImap:Ssl := 1
oImap:Port := 993
nSuccess := oImap:Connect("imap.example.com")
IF (nSuccess == 0)
    ? oImap:LastErrorText
    oImap:destroy()
    RETURN
ENDIF

//  Authenticate
nSuccess := oImap:Login("email_account_login", "email_account_password")
IF (nSuccess == 0)
    ? oImap:LastErrorText
    oImap:destroy()
    RETURN
ENDIF

//  Select an IMAP mailbox
nSuccess := oImap:SelectMailbox("Inbox")
IF (nSuccess == 0)
    ? oImap:LastErrorText
    oImap:destroy()
    RETURN
ENDIF

//  Search for messages with the word "test" in the subject.
nFetchUids := 1

oMessageSet := CreateObject("Chilkat.MessageSet")
nSuccess := oImap:QueryMbx("Subject test", nFetchUids, oMessageSet)
IF (nSuccess == 0)
    ? oImap:LastErrorText
    oImap:destroy()
    oMessageSet:destroy()
    RETURN
ENDIF

//  Download the messages in a single call to FetchMsgSet.
//  
//  This only makes sense if the number of emails to be downloaded is not too large.  
//  For example, you wouldn't want to download 10000 emails in a single call to FetchMsgSet.
//  Why? For two reasons:  (1) It could potentially cause an out-of-memory condition, and 
//  (2) it would take an extremely large amount of time.  The longer the amount of time,
//  the greater the likelihood of some kind of external networking or server problem occuring,
//  and if it happens, then you would need to re-download everything from the beginning again.
//  For large numbers of emails, it's better to loop over the emails in the message set
//  and download/process one at a time as shown here: Download IMAP Messages One at a Time
//  Downloading one message at a time makes it possible to resume the downloads rather than restart the entire operation all over again.

//  If the message set is reasonable in size, you can download all at once using FetchMsgSet:

? "Number of messages = " + Str(oMessageSet:Count)

oBundle := CreateObject("Chilkat.EmailBundle")
nHeadersOnly := 0
nSuccess := oImap:FetchMsgSet(nHeadersOnly, oMessageSet, oBundle)
IF (nSuccess == 0)
    ? oImap:LastErrorText
    oImap:destroy()
    oMessageSet:destroy()
    oBundle:destroy()
    RETURN
ENDIF

//  Display the Subject and From of each email.
oEmail := CreateObject("Chilkat.Email")
i := 0
nNumEmails := oBundle:MessageCount
DO WHILE i < nNumEmails
    oBundle:EmailAt(i, oEmail)

    ? oEmail:GetHeaderField("Date")
    ? oEmail:Subject
    ? oEmail:From
    ? "--"
    i := i + 1
ENDDO

oImap:destroy()
oMessageSet:destroy()
oBundle:destroy()
oEmail:destroy()