(PowerBuilder) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
integer li_Success
oleobject loo_Imap
integer li_FetchUids
oleobject loo_MessageSet
oleobject loo_Bundle
integer li_HeadersOnly
oleobject loo_Email
integer i
integer li_NumEmails

li_Success = 0

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

loo_Imap = create oleobject
li_rc = loo_Imap.ConnectToNewObject("Chilkat.Imap")
if li_rc < 0 then
    destroy loo_Imap
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Connect using TLS.
loo_Imap.Ssl = 1
loo_Imap.Port = 993
li_Success = loo_Imap.Connect("imap.example.com")
if li_Success = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    return
end if

// Authenticate
li_Success = loo_Imap.Login("email_account_login","email_account_password")
if li_Success = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    return
end if

// Select an IMAP mailbox
li_Success = loo_Imap.SelectMailbox("Inbox")
if li_Success = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    return
end if

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

loo_MessageSet = create oleobject
li_rc = loo_MessageSet.ConnectToNewObject("Chilkat.MessageSet")

li_Success = loo_Imap.QueryMbx("Subject test",li_FetchUids,loo_MessageSet)
if li_Success = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    destroy loo_MessageSet
    return
end if

// 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:

Write-Debug "Number of messages = " + string(loo_MessageSet.Count)

loo_Bundle = create oleobject
li_rc = loo_Bundle.ConnectToNewObject("Chilkat.EmailBundle")

li_HeadersOnly = 0
li_Success = loo_Imap.FetchMsgSet(li_HeadersOnly,loo_MessageSet,loo_Bundle)
if li_Success = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    destroy loo_MessageSet
    destroy loo_Bundle
    return
end if

// Display the Subject and From of each email.
loo_Email = create oleobject
li_rc = loo_Email.ConnectToNewObject("Chilkat.Email")

i = 0
li_NumEmails = loo_Bundle.MessageCount
do while i < li_NumEmails
    loo_Bundle.EmailAt(i,loo_Email)

    Write-Debug loo_Email.GetHeaderField("Date")
    Write-Debug loo_Email.Subject
    Write-Debug loo_Email.From
    Write-Debug "--"
    i = i + 1
loop


destroy loo_Imap
destroy loo_MessageSet
destroy loo_Bundle
destroy loo_Email