Triggered email API

Use the triggered email API to work with the metadata of triggered emails and email fragments. The metadata is stored in the common/metadata/triggeredEmails.json file. You can update the file location and filename in the metadata and emailsManifest properties in ./.ewizard/settings.json. For more information, see Triggered emails.

To access the API, use the methods in the browser console in eWizard Editor.

TIP: The email or fragment must include the triggeredEmails.json file for the API to work.

Use this context to access the API and its methods:

Use the following methods of the triggered email API to add, update, or get the triggeredEmails.json data:

• addEmail

• addFragment

• emailsJson

• getEmailById

• getEmailsJsons

• getFragmentById

• removeEmail

• removeFragment

• updateEmail

• updateFragment

The addEmail method adds an email ID and other metadata fields such as name or url to the emails object in the triggeredEmails.json file.

The addFragment method adds an email fragment ID and other metadata fields such as name or url to the fragments object in the triggeredEmails.json file.

Use the getEmailById method to get the data from the emails field of the triggeredEmail.json file. Use the email ID to get the data.

Use the getEmailsJson method to return all the emails and fragments from the triggeredEmails.json file of your e-Detailer project.

The getEmailsJson method has no parameters.

Use the getFragmentById method to get the data from the fragments field of the triggeredEmails.json file. Use the email fragment ID to get the data.

Use the removeEmail method to remove an email and its metadata from the emails field of the triggeredEmails.json file. Enter the email ID to remove the metadata.

Use the removeFragment method to remove an email fragment and its metadata from the fragments field of the triggeredEmails.json file. Enter the email fragment ID to remove the metadata.

Use this method to update the email metadata in the triggeredEmails.json file. Enter the ID of the email to update the metadata in it.

Use this method to update the email fragment metadata fields in the triggeredEmails.json file. Enter the ID of the email fragment to update the metadata in it.