Lua

Delete a Bundle of POP3 Messages

Demonstrates the Chilkat MailMan.DeleteBundle method, which deletes POP3 messages using the UIDLs stored in the X-UIDL headers of the Email objects in an EmailBundle. An email without an X-UIDL header is skipped. This example fetches all messages and deletes them.

Background: DeleteBundle is the batch version of DeleteEmail: it marks every message in a downloaded bundle for deletion in one call. A typical "download and clear the mailbox" workflow is to fetch all messages, process them, then delete the whole bundle. Because a bundle can be filtered or built selectively, you can also delete just the subset you no longer need. The deletions commit when the POP3 session ends.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the MailMan.DeleteBundle method, which deletes POP3 messages using the UIDLs
-- stored in the X-UIDL headers of the Email objects in an EmailBundle.  An email without an
-- X-UIDL header is skipped.

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 all messages (headers are enough; each carries an X-UIDL header).
local bundle = chilkat.EmailBundle.new()

local success = mailman:fetch_all(true, true, 0, bundle)
if not success then
    print(mailman.last_error_text)
    return
end

-- Delete every message in the bundle.
success = mailman:delete_bundle(bundle)
if not success then
    print(mailman.last_error_text)
    return
end

-- Unless the ImmediateDelete property is set to true, the messages are only marked for
-- deletion.  End the POP3 session (which sends the QUIT command) to commit the deletions.
success = mailman:pop3_end_session()
if not success then
    print(mailman.last_error_text)
    return
end

print("Deleted " .. bundle.message_count .. " messages from the POP3 server.")

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