Interface TemplatedEmailData

The data to send a templated email. Note: templated email don't support attachments by now.

interface TemplatedEmailData {
    bccAddresses?: string[];
    ccAddresses?: string[];
    configurationSet?: string;
    replyToAddresses?: string[];
    template: string;
    templateData: {
        [variable: string]: any;
    };
    toAddresses: string[];
}

Hierarchy (view full)

Properties

bccAddresses? ccAddresses? configurationSet? replyToAddresses? template templateData toAddresses

Properties

OptionalbccAddresses

bccAddresses?: string[]

Array of BCC email addresses.

OptionalccAddresses

ccAddresses?: string[]

Array of CC email addresses.

OptionalconfigurationSet

configurationSet?: string

The name of the configuration set to use for the sending.

OptionalreplyToAddresses

replyToAddresses?: string[]

Array of Reply-To email addresses.

template

template: string

The template to use for sending the email. To reference variables, use placeholders such as {{myVar}}.

templateData

templateData: {
    [variable: string]: any;
}

An object containing key-value pairs of variable-content to substitute. It supports handlebars.js templating.

toAddresses

toAddresses: string[]

Array of TO email addresses.

Settings

Member Visibility

On This Page

Properties