Email

The Email output allows you to send an email via an externally accessible SMTP server. The subject and message body of the email can be configured to use attribute values. An email will be sent for each output feature sent to the output.

Example

  • An analyst configures a real-time analytic to filter events ingested by a feed and then sends an email for any features that meet the filter criteria.
  • After performing analysis in a big data analytic, a researcher wants to summarize attributes of the results and send the resulting information in an email.

Usage notes

  • The SMTP server must be externally accessible on the Internet.
  • When using the Email output, it is important to understand the velocity of the data. Each record sent to the output will generate a separate email. This could quickly overload the capacity or rate limiting settings of an SMTP server. The recommended best practice is to use the Email output for incidents expected to occur infrequently.

Parameters

ParameterDescriptionData Type

SMTP host

The SMTP server that will send the email. For example:

smtp.HOST-NAME.com

String

SMTP server security

The type of SMTP encryption to use on all outgoing messages. Options include:

  • STARTTLS
  • SSL/TLS

Username

Username for the SMTP server.

String

Password

Password for the SMTP server.

Password

From email address

The address that will appear as the sender of the email.

Email

To email address

The email recipient. If sending to more than one email recipient, use a comma-separated list.

Email

Subject

The subject of the email. The subject can be configured in a singleline Arcade expression.

Arcade Singleline Text

Message body

The body of the email. The message body can be configured in a multiline Arcade expression.

Access feature attribute values by enclosing it in the following token sequence:

$${$feature.any_attribute_name}

Arcade Multiline Text

Considerations and limitations

  • The SMTP server must be externally accessible on the Internet.