(Visual FoxPro) Download IMAP Message Set using FetchBundle

Demonstrates how to read IMAP emails using the FetchBundle method.

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

LOCAL loImap
LOCAL lnSuccess
LOCAL lnFetchUids
LOCAL loMessageSet
LOCAL loBundle
LOCAL i
LOCAL lnNumEmails
LOCAL loEmail

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Imap')
loImap = CreateObject('Chilkat.Imap')

* Connect using TLS.
loImap.Ssl = 1
loImap.Port = 993
lnSuccess = loImap.Connect("imap.example.com")
IF (lnSuccess <> 1) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

* Authenticate
lnSuccess = loImap.Login("email_account_login","email_account_password")
IF (lnSuccess <> 1) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

* Select an IMAP mailbox
lnSuccess = loImap.SelectMailbox("Inbox")
IF (lnSuccess <> 1) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

* Search for messages with the word "test" in the subject.
lnFetchUids = 1
loMessageSet = loImap.Search("Subject test",lnFetchUids)
IF (loImap.LastMethodSuccess <> 1) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
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 = 0) THEN
    RELEASE loMessageSet
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
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