Lua

Explicitly Begin a POP3 Session

Demonstrates the Chilkat MailMan.Pop3BeginSession method, which explicitly begins a POP3 session by connecting to the POP3 server and authenticating using the current POP3 property settings. Calling it is optional. This example begins a session, performs a mailbox operation, and ends the session.

Background: Pop3BeginSession combines connecting and authenticating into one call. Chilkat does this automatically when a mailbox operation needs it, so the value of calling it explicitly is control: you open one session, perform several operations against it, and close it with Pop3EndSession — avoiding repeated connect/authenticate round trips and keeping deletion marks within a single, well-defined session.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the MailMan.Pop3BeginSession method, which explicitly begins a POP3 session
-- by connecting to the POP3 server and authenticating using the current POP3 property
-- settings.

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"

-- Explicitly begin the POP3 session (connect + authenticate).

local success = mailman:pop3_begin_session()
if not success then
    print(mailman.last_error_text)
    return
end

-- Perform one or more mailbox operations within this single session.
print("Mailbox count: " .. mailman:get_mailbox_count())

-- End the session when finished.
success = mailman:pop3_end_session()
if not success then
    print(mailman.last_error_text)
    return
end

print("POP3 session completed.")