(Lianja) Download an IMAP Message Set

Demonstrates how to read a set of IMAP emails.

Note: This example requires Chilkat v11.0.0 or greater.

Chilkat Lianja Extension Download Chilkat Lianja Extension

llSuccess = .F.

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

loImap = createobject("CkImap")

// Connect using TLS.
loImap.Ssl = .T.
loImap.Port = 993
llSuccess = loImap.Connect("imap.example.com")
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

// Authenticate
llSuccess = loImap.Login("email_account_login","email_account_password")
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

// Select an IMAP mailbox
llSuccess = loImap.SelectMailbox("Inbox")
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

// Search for messages with the word "test" in the subject.
llFetchUids = .T.

loMessageSet = createobject("CkMessageSet")
llSuccess = loImap.QueryMbx("Subject test",llFetchUids,loMessageSet)
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    release loMessageSet
    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(loMessageSet.Count)

loBundle = createobject("CkEmailBundle")
llHeadersOnly = .F.
llSuccess = loImap.FetchMsgSet(llHeadersOnly,loMessageSet,loBundle)
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    release loMessageSet
    release loBundle
    return
endif

// Display the Subject and From of each email.
loEmail = createobject("CkEmail")
i = 0
lnNumEmails = loBundle.MessageCount
do while i < lnNumEmails
    loBundle.EmailAt(i,loEmail)

    ? loEmail.GetHeaderField("Date")
    ? loEmail.Subject
    ? loEmail.From
    ? "--"
    i = i + 1
enddo


release loImap
release loMessageSet
release loBundle
release loEmail