Lua

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 Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- 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.

local mailman = chilkat.MailMan.new()

-- Configure the POP3 server connection.
mailman.mail_host = "pop.example.com"
mailman.mail_port = 995
mailman.pop_ssl = true
mailman.pop_username = "user@example.com"
mailman.pop_password = "myPassword"

-- Build the set of UIDLs to fetch.
local uidls = chilkat.StringTable.new()
uidls:append("0000000123abcdef")
uidls:append("0000000124abcdef")

-- Fetch the listed messages (full bodies) into a bundle.
-- headersOnly=false (fetch the entire message).
-- Note: numBodyLines only applies when headersOnly is true (it sets how many lines of the
-- body to include along with the headers).  When headersOnly is false, the entire message
-- is fetched and numBodyLines is ignored.
local bundle = chilkat.EmailBundle.new()

local success = mailman:fetch_uidl_set(uidls, false, 0, bundle)
if not success then
    print(mailman.last_error_text)
    return
end

local n = bundle.message_count
print("Fetched " .. n .. " messages.")

local email = chilkat.Email.new()
for i = 0, n - 1 do
    success = bundle:email_at(i, email)
    print(email.subject)
end

-- 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.