Visual FoxPro

Download an IMAP Message Set

Demonstrates how to read a set of IMAP emails. Visual FoxPro

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

lnSuccess = 0

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

loImap = CreateObject('Chilkat.Imap')

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

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

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

* Search for messages with the word "test" in the subject.
lnFetchUids = 1

loMessageSet = CreateObject('Chilkat.MessageSet')
lnSuccess = loImap.QueryMbx("Subject test",lnFetchUids,loMessageSet)
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    RELEASE loMessageSet
    CANCEL
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('Chilkat.EmailBundle')
lnHeadersOnly = 0
lnSuccess = loImap.FetchMsgSet(lnHeadersOnly,loMessageSet,loBundle)
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    RELEASE loMessageSet
    RELEASE loBundle
    CANCEL
ENDIF

* Display the Subject and From of each email.
loEmail = CreateObject('Chilkat.Email')
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