Skip to main content

Interface: EmailTemplate

Defined in: type/EmailTemplate.ts:9

Object class for EmailTemplate

Properties​

attachments?​

optional attachments?: DocumentTemplate[]

Defined in: type/EmailTemplate.ts:41

DocumentTemplates to attach to the email

bccs?​

optional bccs?: EmailContact[]

Defined in: type/EmailTemplate.ts:39

BCC EmailContacts for the email

ccs?​

optional ccs?: EmailContact[]

Defined in: type/EmailTemplate.ts:37

CC EmailContacts for the email

content?​

optional content?: string

Defined in: type/EmailTemplate.ts:17

The content of the template

contents?​

optional contents?: LocalizedTemplateContent[]

Defined in: type/EmailTemplate.ts:13

Uploaded handlebars template content, per given language

createdAt​

createdAt: string

Defined in: type/EmailTemplate.ts:23

The creation date of this Template

createdBy?​

optional createdBy?: number

Defined in: type/EmailTemplate.ts:27

ID of the user who created this Template

customQuery?​

optional customQuery?: string

Defined in: type/EmailTemplate.ts:19

GraphQL query to be executed before rendering the template to fetch additional data not in the original event payload.

from​

from: EmailSender

Defined in: type/EmailTemplate.ts:33

From EmailContact for the email

id​

id: string

Defined in: type/EmailTemplate.ts:11

A unique identifier for the template

lastModifiedAt​

lastModifiedAt: string

Defined in: type/EmailTemplate.ts:25

The last modified date of this Template

lastModifiedBy?​

optional lastModifiedBy?: number

Defined in: type/EmailTemplate.ts:29

ID of the user who last modified this Template

names​

names: LocalizedString[]

Defined in: type/EmailTemplate.ts:15

The name of the template per given language

queryVariables?​

optional queryVariables?: string

Defined in: type/EmailTemplate.ts:21

Variables that are use in the custom query, can use handlebars variables. Has to be a valid JSON string after rendering

subjects​

subjects: LocalizedString[]

Defined in: type/EmailTemplate.ts:31

Subject for the email per given language, supports handlebars variables

tos?​

optional tos?: EmailContact[]

Defined in: type/EmailTemplate.ts:35

To EmailContacts for the email