Skip to main content

Function: formatAddress()

formatAddress(__namedParameters): string

Defined in: address.ts:33

A From/Reply-To header value: "Name" <address>. A name with characters outside printable ASCII is written as an RFC 2047 encoded word, which is what SES and most transports require; line breaks are dropped so a name can never inject a header.

Parameters​

ParameterType
__namedParameters{ email: string; name?: string | null; }
__namedParameters.emailstring
__namedParameters.name?string | null

Returns​

string

Example​

formatAddress({ name: 'Solar Ômega', email: 'contato@omega.com.br' });
// '=?UTF-8?B?U29sYXIgw5RtZWdh?= <contato@omega.com.br>'