Email Subscriber

Email subscriber receives notifications from FME Notification Service and delivers emails based on subscribers.

Keywords

The subject, recipients and attachment of an outgoing email can be configured by the following reserved keywords:

email subject
email_to
email_cc
email_from
email_replyto
email_attachment
subscriber_content

For example, a notification message is constructed as below:

{

"email_subject": "This is a sample email",

"email_to": "recipient@example.com",

"email_attachment": "\\myserver\attachment.txt",

"BodyContent1": "This is a paragraph",

"BodyContent2": "This is another paragraph"

}

Upon receiving this notification, the email subscriber will send an email message to recipient@example.com, with subject “This is a sample email” including an attachment, attachment.txt.

If a notification message is sent from FME REST API and it contains unstructured text message, the value of subscriber_content keyword contain the content of the text message.

Subscriber

An email subscriber is a configuration required to deliver email messages. The configuration contains information on the email server (SMTP) connection, authentication, default email subject, recipients, email body template and so on. A complete list of email subscriber properties follows:

SMTP Server - Mail exchanger server host name or IP address used for sending email.
SMTP Server port – Mail exchanger TCP port used for sending email.
SMTP Account – If the SMTP server requires authentication, this is the user name.
SMTP Password – If the SMTP server requires authentication, this is the user password.
SMTP Connection Security - The encryption mechanism used for the connnection, if any.
Email To - Corresponds to the To field in standard email messages.
Email CC – Corresponds to the CC field in standard email messages.
Email From – Corresponds to the From field in standard email messages, if users reply to the notification email message it will be directed to this email address.
Email Subject – Corresponds to the Subject field in standard email messages.
Email Format - The format of the email, either plain text or HTML.
Email Content Template – The message body to use for delivery. This is a template that allows the use of various tags that are replaced with dynamic information before delivery. When the message is provided by an FME Server web service, such as the Data Download or Job Submitter service, the following tags are supported:
{StatusMessage} – The status message of the transformation job that completed.
{id} – The transformation job’s ID.
{urlPrefix} – Prefix of the URL used to download any job transformation result files.
{ResultRootDir} – Root directory fragment part of the URL used to download any job transformation result files.
{@getFilename(@zip(OutputLocation))} – Retrieves the filename fragment part of the URL used to download any job transformation result files. The result files are compiled into a zip file.
Assigned Topics - The FME Server topics for which the email notifications will be delivered.

The following dialog allows the FME Server administrator to configure the email subscription using the Web User Interface.

If email_subject and email_to keywords are specified in the notification, they will override the default email subject and recipients configured in subscriber respectively.

Email Notification Content

Email content is configured via a template on a per subscriber basis, and it defines what is included in the email content and how the content is formatted.

For example, a simple email template may look like:

This is a notification email from FME Server.

{BodyContent1}

{BodyContent2}

If notification shown in the previous example is received, the subscriber will send email with content shown below:

This is a notification email from FME Server.

This is a paragraph.

This is another paragraph.