Xojo Plugin

Fetch All Messages from a POP3 Mailbox

Demonstrates the Chilkat MailMan.FetchAll method, which retrieves messages from the POP3 mailbox and appends them to an EmailBundle. The arguments are keepOnServer, headersOnly, numBodyLines, and the EmailBundle that receives the emails. This example downloads every message and iterates the bundle, printing each subject.

Background: An EmailBundle is Chilkat's container for a set of downloaded messages — you read its MessageCount and pull out each Email with EmailAt. The three flags control how much is fetched: keepOnServer leaves copies in the mailbox rather than removing them, headersOnly downloads just the headers for a fast preview, and numBodyLines can fetch a partial body (0 means the whole body). Traditional POP3 clients download and delete; setting keepOnServer to true supports "leave mail on server" behavior.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the MailMan.FetchAll method, which retrieves messages from the POP3 mailbox
//  and appends them to an EmailBundle.  The arguments are keepOnServer, headersOnly,
//  numBodyLines, and the EmailBundle that receives the emails.

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"

//  Fetch all messages, leaving them on the server, with full bodies.
//  keepOnServer=cktrue, 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.FetchAll(True,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.