Fetch a Range of POP3 Messages

See more POP3 Examples

Demonstrates the Chilkat MailMan.FetchRange method, which retrieves a range of messages from the POP3 mailbox and appends them to an EmailBundle. The arguments are keepOnServer, headersOnly, numBodyLines, a zero-based inclusive startIndex and endIndex, and the EmailBundle. This example fetches the first five messages.

local chilkat = require("chilkat")

-- Demonstrates the MailMan.FetchRange method, which retrieves a range of messages from the
-- POP3 mailbox and appends them to an EmailBundle.  The arguments are keepOnServer,
-- headersOnly, numBodyLines, startIndex, endIndex, and the EmailBundle.  The indexes are
-- zero-based and inclusive.

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"

-- Fetch the first 5 messages (indexes 0 through 4), full bodies, leaving them on the server.
-- keepOnServer=true, 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_range(true, false, 0, 0, 4, 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.