Lua

Get a To Recipient's Name Only

Demonstrates the Chilkat Email.GetToName method, which returns only the friendly-name part (not the address) of the Nth To recipient. The index is zero-based. This example adds two To recipients and prints each one's display name.

Background: The display name is the human-friendly label attached to an address, like Joe Smith for joe@example.com. It is optional and purely cosmetic but useful for presentation. GetToName returns just that name; if a recipient was added without one, the result is empty, in which case fall back to GetToAddr.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the GetToName method, which returns only the friendly-name part (not the
-- address) of the Nth To recipient.  The index is zero-based.

local email = chilkat.Email.new()
email.subject = "GetToName example"

email:add_to("Joe Smith", "joe@example.com")
email:add_to("Jane Doe", "jane@example.com")

local n = email.num_to
for i = 0, n - 1 do
    print("To " .. i .. " name: " .. email:get_to_name(i))
end