Create email template
id/name of the email template without the type prefix
email template object
a promise that resolves to an email template object
Create an empty email template export template
an empty email template export template
Delete email template
id/name of the email template without the type prefix 'emailTemplate/'
a promise that resolves an email template object
Delete all email templates
a promise that resolves to an array of email template objects
Export all email templates. The response can be saved to file as is.
OptionalincludeDefault: boolean
Include default email templates if true, false to exclude them. Default: false
Promise resolving to a EmailTemplateExportInterface object.
Import all email templates. Every email template is tried: a template that cannot be imported does not stop the others.
import data
OptionalresultCallback: ResultCallback<EmailTemplateSkeleton>
Optional callback to process individual results. When given, the outcome of every email template is passed to it as it happens (a failed template as an error that names the template and carries the cause) and a failed template does not throw: the templates that were imported are returned. Without it, the failures are collected and thrown as one error after every template was tried.
a promise resolving to an array of email template objects
Get email template
id/name of the email template without the type prefix
a promise that resolves an email template object
Get all email templates
OptionalincludeDefault: boolean
Include default email templates if true, false to exclude them. Default: false
a promise that resolves to an array of email template objects
Update or create email template
id/name of the email template without the type prefix
email template object
a promise that resolves to an email template object
Email template type key used to build the IDM id: 'emailTemplate/'