PureBasic

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 PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkEmail.pb"

Procedure ChilkatExample()

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

    email.i = CkEmail::ckCreate()
    If email.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkEmail::setCkSubject(email, "GetToName example")

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

    n.i = CkEmail::ckNumTo(email)
    i.i
    For i = 0 To n - 1
        Debug "To " + Str(i) + " name: " + CkEmail::ckGetToName(email,i)
    Next


    CkEmail::ckDispose(email)


    ProcedureReturn
EndProcedure