Email Services Extensions

Email Services Extensions define classes and properties of an email notification system.

Note: Applications that require the Email Services Extensions add-on typically install the add-on automatically as part of deploying and configuring the application, or the application's documentation directs you to install the add-on. Do not install the add-on unless you are using an application that requires the add-on.

When you install the Email Template Extensions add-on, Content Platform Engine automatically creates the Email Custom Queue Sweep background task. The sweep task sends an e-mail to all recipients when you create an instance of the EmsEmailQueue class.

The CmSMTPConfiguration value for your domain must be a valid SMTP server. Configure the CmSMTPConfiguration value in the SMTP Subsystem tab of your domain in Administration Console for Content Platform Engine.

You can use Administration Console for Content Platform Engine to view the metadata.

Display name
Email Services Extensions
Installation type
Optional
Predecessors
None
Required by
None

Property templates

The following property templates are added by Email Services Extensions and implemented by various feature add-ons.

Property template Type Maximum string length Description
EmsToNames String 1024 List of email addresses for the To: field of the email
EmsCcNames String 1024 List of email addresses for the Cc: field of the email
EmsBccNames String 1024 List of email addresses for the Bcc: field of the email
EmsFromName String 1024 Address of the email sender
EmsReplyToName String 1024 Address of the account that you reply to
EmsSubject String 1024 Subject of the email
EmsBody String 26214400 Body of the email
EmsBodyContentType String 64 Content type of the email. For example, "text" or "html".
emsBodyContentCharSet String 64 Content character set of the email. For example, "UTF-8".
EmsTemplateSymbolicName String 64 Symbolic name of the email template
EmsTemplateLocale String 64 Locale of the email template. For example, "en-US".
EmsTemplateCharSet String 64 Character set of the email template. For example, "UTF-8".
EmsTemplateSubject String 1024 Subject of the template
EmsTemplateBody String 26214400 Body of the template

Custom Subclasses that are added to the Abstract Persistable class

The following subclasses are derived from the Abstract Persistable class by Email Services Extensions.

Subclass Symbolic name Modifiable Description
Email Queue Entry EmsEmailQueueEntry No Represents a queue entry that contains an email service request. The entry is processed by an email queue sweep.
Email Template EmsEmailTemplate No Represents a translated template for the email body and subject.

Email Queue Entry, subclass of Abstract Queue Entry class

The following properties are added to the Email Queue Entry subclass by Email Services Extensions.

Property Type Modifiable Description
EmsToNames String 1024 List of email addresses for the To: field of the email
EmsCcNames String 1024 List of email addresses for the Cc: field of the email
EmsBccNames String 1024 List of email addresses for the Bcc: field of the email
EmsFromName String 1024 Address of the email sender
EmsReplyToName String 1024 Address of the account that you reply to
EmsSubject String 1024 Subject of the email
EmsBody String 26214400 Body of the email
EmsBodyContentType String 64 Content type of the email. For example, "text" or "html".
emsBodyContentCharSet String 64 Content character set of the email. For example, "UTF-8".

Email Template, subclass of Abstract Queue Entry class

The following properties are added to the Email Template subclass by Email Services Extensions.

Property Type Modifiable Description
EmsTemplateSymbolicName String 64 Symbolic name of the email template
EmsTemplateLocale String 64 Locale of the email template. For example, "en-US".
EmsTemplateCharSet String 64 Character set of the email template. For example, "UTF-8".
EmsTemplateSubject String 1024 Subject of the template
EmsTemplateBody String 26214400 Body of the template