Skip to main content

EmailTemplate

No description

type EmailTemplate implements IBaseTemplate {
id: String!
contents: [LocalizedTemplateContent!]
names(
language: String
): [LocalizedString!]!
content: String
customQuery: String
queryVariables: String
createdAt: DateTime!
lastModifiedAt: DateTime!
createdBy: Int
lastModifiedBy: Int
subjects(
language: String
): [LocalizedString!]!
from: EmailSender!
tos: [EmailContact!]
ccs: [EmailContact!]
bccs: [EmailContact!]
attachments: [DocumentTemplate!]
}

Fields

EmailTemplate.id ● String! non-null scalar

A unique identifier for the template

EmailTemplate.contents ● [LocalizedTemplateContent!] list object

Uploaded handlebars template content, per given language

EmailTemplate.names ● [LocalizedString!]! non-null object

The name of the template per given language

EmailTemplate.names.language ● String scalar

Filter for filtering LocalizedString entities by language

EmailTemplate.content ● String scalar

The content of the template

EmailTemplate.customQuery ● String scalar

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

EmailTemplate.queryVariables ● String scalar

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

EmailTemplate.createdAt ● DateTime! non-null scalar

The creation date of this Template

EmailTemplate.lastModifiedAt ● DateTime! non-null scalar

The last modified date of this Template

EmailTemplate.createdBy ● Int scalar

ID of the user who created this Template

EmailTemplate.lastModifiedBy ● Int scalar

ID of the user who last modified this Template

EmailTemplate.subjects ● [LocalizedString!]! non-null object

Subject for the email per given language, supports handlebars variables

EmailTemplate.subjects.language ● String scalar

Filter for filtering LocalizedString entities by language

EmailTemplate.from ● EmailSender! non-null object

From EmailContact for the email

EmailTemplate.tos ● [EmailContact!] list object

To EmailContacts for the email

EmailTemplate.ccs ● [EmailContact!] list object

CC EmailContacts for the email

EmailTemplate.bccs ● [EmailContact!] list object

BCC EmailContacts for the email

EmailTemplate.attachments ● [DocumentTemplate!] list object

DocumentTemplates to attach to the email

Interfaces

IBaseTemplate interface

Returned By

emailTemplateAddAttachment mutation ● emailTemplateCreate mutation ● emailTemplateRemoveAttachment mutation ● emailTemplateUpdate mutation