Lua

Clear an Email Object

Demonstrates the Chilkat Email.Clear method, which removes the current message content — recipients, headers, body representations, attachments, related items, and embedded messages — leaving an empty email object. This example builds a message with a recipient and attachment, clears it, and prints the counts before and after.

Background: Reusing a single Email object across many operations is efficient, but leftover state from a previous message could leak into the next. Clear resets the object completely, giving you a clean slate — the safe way to start a fresh message without allocating a new object.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the Clear method, which removes the current message content, including
-- recipients, headers, body representations, attachments, related items, and embedded
-- messages -- leaving an empty email object.

local email = chilkat.Email.new()
email.subject = "A message"
email.body = "Some body text."
email:add_to("Bob", "bob@example.com")
email:add_string_attachment("notes.txt", "Some notes.")

print("NumTo before clear = " .. email.num_to)
print("NumAttachments before clear = " .. email.num_attachments)

-- Remove all content, resetting the email object.
email:clear()

print("NumTo after clear = " .. email.num_to)
print("NumAttachments after clear = " .. email.num_attachments)