EmailTemplate Data Type

An object that defines the content of a marketing email.

Properties
name data type constraints description
subject string required
code string required
name string required
htmlContent string required
design EmailDesign   The design information for this template.
fromName string  
fromAddress string  
textContent string  
smtpHost string   The SMTP host to use as the sender for the email.
hostUser string   The username that can log into the SMTP host.
hostPassword string   The password to log into the SMTP host with.
Properties inherited from BaseHibernateEntity
id number   The unique internal ID of the object.
version number   For internal use only. This is the serialization recorder for optimistic locking of several objects between sessions.
Properties inherited from BaseEntity
violations array of SimpleViolation   A list of constraint violations, if any, that this object has.

Example

{
  "subject" : "...",
  "code" : "...",
  "name" : "...",
  "htmlContent" : "...",
  "design" : {
    "header" : "...",
    "footer" : "...",
    "style" : "...",
    "includeUnsubscribeLink" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "fromName" : "...",
  "fromAddress" : "...",
  "textContent" : "...",
  "smtpHost" : "...",
  "hostUser" : "...",
  "hostPassword" : "...",
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}