Documentation
Email Template

We send emails for different communication purposes. Email templates allow to customize those emails.

States
  • Create
    The create state indicates that the Email Template is in creation.
  • Active
    The active state indicates that the Email Template is active and may be used.
  • Inactive
    The inactive state indicates that the Email Template is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Email Template is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Attached Document Template Types
  • Blind Carbon Copy Recipients
  • Carbon Copy Recipients
  • Default Email Template
    The default email template is used whenever no specific template is specified for a particular template type.
  • Html Body Template Resource
    The HTML body resource is used to produce the actual HTML message of the email.
  • Id
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • Linked Space ID
    The linked space id holds the ID of the space to which the entity belongs to.
  • Name
    The template name is used internally to identify the template in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
  • Planned Purge Date
    The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
  • Sending Enabled
  • State

    An email template can have the following states:

    Active

    When the state is set to Active this template will be used for the email.

    Inactive

    When the state is set to Inactive you can’t use this template for the email. However, all the information is not deleted and you can reactivate the template at any moment.

    Deleting

    The template is in the process of deletion. This may take some time until the template is marked as Deleting before being marked as Deleted.

    Deleted

    The template is deleted. Since the template is linked with data which cannot be deleted immediately, we need to keep it until all the data can be removed.

  • Subject
    The subject is going to be shown to the customer as a title.
  • Text Body Template Resource
    The text body resource is used to produce the actual text message of the email. In case no resource is selected the HTML message is translated into the text format.
  • Type
  • Version
    The version number indicates the version of the entity. The version is incremented whenever the entity is changed.