(PowerBuilder) Fetch Inbox Email Headers

Downloads the headers of all emails in the Inbox and shows some information about each, such as From, Subject, and whether the email has been seen (already read) or not.

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_Count
oleobject loo_Bundle
oleobject loo_EmailHeader
integer i
integer li_SeenFlag

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 to an IMAP server.
// Use TLS
loo_Imap.Ssl = 1
loo_Imap.Port = 993
li_Success = loo_Imap.Connect("imap.someMailServer.com")
if li_Success = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    return
end if

// Login
li_Success = loo_Imap.Login("myLogin","myPassword")
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

// Normally, when an email is downloaded, its "Seen" flag is automatically set.
// We don't want our program to be interfering with the "Seen" flags.
// To do this, set the PeekMode to 1.
loo_Imap.PeekMode = 1

// After selecting the mailbox, the NumMessages property
// will contain the number of emails in the mailbox.
// When sequence numbers (not UIDs) are used to reference emails,
// they range from 1 to N, where N is the number of messages in the mailbox.
// This example will download the headers by sequence numbers.
li_Count = loo_Imap.NumMessages

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

li_Success = loo_Imap.FetchRange(1,1,li_Count,loo_Bundle)
if li_Success = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    destroy loo_Bundle
    return
end if

if loo_Bundle.MessageCount = 0 then
    Write-Debug "No messages in Inbox."
    destroy loo_Imap
    destroy loo_Bundle
    return
end if

// Loop over the email headers.  
loo_EmailHeader = create oleobject
li_rc = loo_EmailHeader.ConnectToNewObject("Chilkat.Email")

i = 0
do while i < loo_Bundle.MessageCount

    loo_Bundle.EmailAt(i,loo_EmailHeader)

    Write-Debug loo_EmailHeader.From
    Write-Debug loo_EmailHeader.Subject

    // Get the "Seen" flag.
    // When an email is fetched from the IMAP server, the email flags are stored
    // within the email in the "ckx-imap-flags" header.
    // The call to GetMailFlag is simply getting the information from the email header.
    // (it is not communicating with the IMAP server to get this information, because
    // the information was obtained when downloading the headers)
    li_SeenFlag = loo_Imap.GetMailFlag(loo_EmailHeader,"Seen")
    if li_SeenFlag = 1 then
        Write-Debug "This email has been read (already seen)"
    else
        Write-Debug "This email has not yet been read (it is not yet seen)"
    end if

    // We can also look directly at the "ckx-imap-flags" header:
    Write-Debug "ckx-imap-flags: " + loo_EmailHeader.GetHeaderField("ckx-imap-flags")

    Write-Debug "--"

    i = i + 1
loop

// Disconnect from the IMAP server.
li_Success = loo_Imap.Disconnect()


destroy loo_Imap
destroy loo_Bundle
destroy loo_EmailHeader