Xojo Plugin

Get a To Recipient's Name Only

See more Email Object Examples

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 Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

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

Dim email As New Chilkat.Email
email.Subject = "GetToName example"

Dim success As Boolean
success = email.AddTo("Joe Smith","joe@example.com")
success = email.AddTo("Jane Doe","jane@example.com")

Dim n As Int32
n = email.NumTo
Dim i As Int32
For i = 0 To n - 1
    System.DebugLog("To " + Str(i) + " name: " + email.GetToName(i))
Next