Email Server-Side JavaScript Functions

Initialize

To interact with an email via server-side JavaScript, you must first initialize the object. The code below initializes an email with the external key of 'myEmail'.

var myEmail = Email.Init("myEmail");

Once you initialize the email, you can use the remaining functions contained on this page.

Add(email)

This function adds a new email to your account and returns an initialized object.

var newMail = {
    "CustomerKey" : "test_email_key",
    "Name" : "Test Email",
    "CategoryID" : "",
    "HTMLBody" : "<b>This is a test email</b>",
    "TextBody" : "This is a test email",
    "Subject" : "Test Email Subject",
    "IsActive" : "true",
    "IsHTMLPaste" : "true",
    "Status" : "active",    
    "EmailType" : "HTML",
    "CharacterSet" : "US-ASCII",
    "HasDynamicSubjectLine" : "false"
};
var myEmail = Email.Add(newMail);

Remove()

This function removes a previously initialized email.

The sample code below deletes the email with the external key myEmail:

var myEmail = Email.Init("myEmail");
myEmail.Remove();

Retrieve(filter)

This function retrieves an array of emails based on the specified criteria.

var results = Email.Retrieve({Property:"CustomerKey",SimpleOperator:"equals",Value:"myEmail"});

Update(attributes)

This function updates the email and returns a status.

var myEmail = Email.Init("myEmail");
var status = myEmail.Update({ "Name": "Updated Name", "Subject" : "Updated Email Subject" });

CheckContent()

This function runs content checks on the initialized email (similar to the Content Detective tool) and returns a JSON object indicating the result of the content check and any identified issues.

The following code calls CheckContent() on the initialized email object and writes out the results from the returned JSON object:

var myEmail = Email.Init("myEmail");
var results = myEmail.CheckContent();
Write(results.Task.CheckPassed);
Write(results.Task.ResultMessage);

Validate()

This function runs validation checks on the initialized email and returns a JSON object indicating the result of the validation and any identified issues.

The following code calls Validate() on the initialized email object and writes out the results from the returned JSON object:

var myEmail = Email.Init("myEmail");
var results = myEmail.Validate();
Write(results.Task.ValidationStatus);
Write(results.Task.ValidationMessages);