Xojo Plugin

Fetch a Set of POP3 Messages by UIDL

Demonstrates the Chilkat MailMan.FetchUidlSet method, which retrieves the messages whose UIDLs are listed in a StringTable and appends them to an EmailBundle. The arguments are the UIDL StringTable, headersOnly, numBodyLines, and the EmailBundle. This example fetches two specific messages by UIDL.

Background: This is the efficient way to download a selected subset of a mailbox in one call — exactly the pattern for an incremental client: list the mailbox UIDLs, compare against the ones you've already stored, and fetch only the new UIDLs as a set. It avoids re-downloading messages you already have while still pulling everything new in a single operation.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the MailMan.FetchUidlSet method, which retrieves the messages whose UIDLs are
//  listed in a StringTable and appends them to an EmailBundle.  The arguments are the UIDL
//  StringTable, headersOnly, numBodyLines, and the EmailBundle.  The messages remain on the
//  server.

Dim mailman As New Chilkat.MailMan

//  Configure the POP3 server connection.
mailman.MailHost = "pop.example.com"
mailman.MailPort = 995
mailman.PopSsl = True
mailman.PopUsername = "user@example.com"
mailman.PopPassword = "myPassword"

//  Build the set of UIDLs to fetch.
Dim uidls As New Chilkat.StringTable
success = uidls.Append("0000000123abcdef")
success = uidls.Append("0000000124abcdef")

//  Fetch the listed messages (full bodies) into a bundle.
//  headersOnly=ckfalse (fetch the entire message).
//  Note: numBodyLines only applies when headersOnly is 1 (it sets how many lines of the
//  body to include along with the headers).  When headersOnly is 0, the entire message
//  is fetched and numBodyLines is ignored.
Dim bundle As New Chilkat.EmailBundle

success = mailman.FetchUidlSet(uidls,False,0,bundle)
If (success = False) Then
    System.DebugLog(mailman.LastErrorText)
    Return
End If

Dim n As Int32
n = bundle.MessageCount
System.DebugLog("Fetched " + Str(n) + " messages.")

Dim email As New Chilkat.Email
Dim i As Int32
For i = 0 To n - 1
    success = bundle.EmailAt(i,email)
    System.DebugLog(email.Subject)
Next

//  Note: Explicitly connecting/authenticating is optional.  Chilkat MailMan automatically
//  connects and authenticates -- using the property settings above -- whenever a server
//  operation requires it.  Calling the explicit connect/authenticate methods can still be
//  helpful to determine whether a failure occurs while connecting or while authenticating.