(Lianja) Download IMAP Message Set using FetchBundle

Demonstrates how to read IMAP emails using the FetchBundle method.

Chilkat Lianja Extension Download Chilkat Lianja Extension

// 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 <> .T.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

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

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

// Search for messages with the word "test" in the subject.
llFetchUids = .T.
loMessageSet = loImap.Search("Subject test",llFetchUids)
if (loImap.LastMethodSuccess <> .T.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

// Download the messages in a single call to FetchBundle.
// 
// 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 FetchBundle.
// 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 FetchBundle:

? "Number of messages = " + str(loMessageSet.Count)

loBundle = loImap.FetchBundle(loMessageSet)
if (loImap.LastMethodSuccess = .F.) then
    release loMessageSet
    ? loImap.LastErrorText
    release loImap
    return
endif

// Display the Subject and From of each email.
i = 0
lnNumEmails = loBundle.MessageCount
do while i < lnNumEmails
    loEmail = loBundle.GetEmail(i)

    ? loEmail.GetHeaderField("Date")
    ? loEmail.Subject
    ? loEmail.From
    ? "--"

    release loEmail
    i = i + 1
enddo

release loMessageSet
release loBundle


release loImap