ESPRMAdminMessageTemplate
Defined in: src/ESPRMAdminMessageTemplate.ts:11
Shell class for admin message template operations. Methods are added via prototype augmentation in methods/ESPRMAdminMessageTemplate/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminMessageTemplate():
ESPRMAdminMessageTemplate
Returns
Section titled “Returns”ESPRMAdminMessageTemplate
Methods
Section titled “Methods”createMessageTemplate()
Section titled “createMessageTemplate()”createMessageTemplate(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminMessageTemplate/CreateMessageTemplate.ts:22
Creates a new deployment message template.
Parameters
Section titled “Parameters”params
Section titled “params”Message-template payload (template_type, locale, subject, body).
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming template creation.
deleteMessageTemplate()
Section titled “deleteMessageTemplate()”deleteMessageTemplate(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminMessageTemplate/DeleteMessageTemplate.ts:22
Deletes an email message template from the deployment.
Parameters
Section titled “Parameters”params
Section titled “params”Parameters identifying the template to delete.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the deletion.
getMessageTemplates()
Section titled “getMessageTemplates()”getMessageTemplates(
params?):Promise<GetMessageTemplatesResponse>
Defined in: src/methods/ESPRMAdminMessageTemplate/GetMessageTemplates.ts:22
Retrieves deployment message templates.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional filter params (for example template_type).
Returns
Section titled “Returns”Promise<GetMessageTemplatesResponse>
The list of message templates.
getVerifiedEmails()
Section titled “getVerifiedEmails()”getVerifiedEmails():
Promise<GetVerifiedEmailsResponse>
Defined in: src/methods/ESPRMAdminMessageTemplate/GetVerifiedEmails.ts:20
Retrieves the list of SES-verified email addresses for the deployment.
Returns
Section titled “Returns”Promise<GetVerifiedEmailsResponse>
The verified email addresses.
updateMessageTemplate()
Section titled “updateMessageTemplate()”updateMessageTemplate(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminMessageTemplate/UpdateMessageTemplate.ts:22
Updates an existing deployment message template.
Parameters
Section titled “Parameters”params
Section titled “params”Message-template payload (template_type, locale, subject, body).
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the update.