An email template combines parameter substitution strings and regular text strings. An email template can be one of three types: header, body, or footer.
You can change the text strings and the order of the substitution parameters in an email template, and you can add or remove parameters. Not all template types support all available parameters. Adding a parameter that is not supported by an email template type results in errors in the generated email.
Substitution parameters must be in the following format: ${parameter_name}
A header template does not have any parameters. The subject of the email is taken from the EmsTemplateSubject property, which is defined in the EmsEmail Template base class.
Parameter | Object type | Description |
---|---|---|
ClbObjectStoreId | Document, folder | The GUID of the object store. |
ClbDomainId | Document, folder | The GUID of the domain. |
ClbNotificationBaseURL | Document, folder | The base URL for HTTP links for documents and folders. |
ClbObjectName | Document, folder | The name of the document or folder that the event occurred on. |
ClbActor | Document, folder | The name of the user whose action fired the event. |
ClbEventDateTime | Document, folder | The date and time that the event occurred. |
ClbDocumentMajorVersion | Document | The document's major version number. |
ClbDocumentMinorVersion | Document | The document's minor version number. |
ClbVersionSeriesId | Document | The GUID of the document version series. |
ClbObjectId | Document, folder | The GUID of the object that triggered the event. |
ClbTemplateClass | Document, folder | The class of the object that triggered the event. |
ClbTargetName | Document, folder | The name of the folder where the object resides. |
Parameter | Description |
---|---|
ClbNow | The date and time the email was generated. |