Lua

Get the POP3 Mailbox Message Count

Demonstrates the Chilkat MailMan.GetMailboxCount method, which returns the number of emails currently available in the POP3 mailbox, or -1 if an error occurs. It is functionally identical to CheckMail. This example configures the POP3 connection and reads the count.

Background: The message count is the number of messages sitting in the POP3 maildrop — the server-side spool that holds mail until a client downloads (and typically deletes) it. Because POP3's traditional model moves mail off the server, this count is essentially the size of the "inbox to be picked up." Chilkat auto-connects using the configured MailHost, credentials, and SSL settings if no session is open.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the MailMan.GetMailboxCount method, which returns the number of emails
-- currently available in the POP3 mailbox (or -1 if an error occurs).  It is functionally
-- identical to CheckMail.

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"

local count = mailman:get_mailbox_count()
print("Mailbox message count: " .. count)

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