The Email output in ArcGIS Velocity allows you to send an email through an externally accessible Simple Mail Transfer Protocol (SMTP) server. The subject and message body of the email can be configured to use attribute values. An email is sent for each output feature sent to the output.
Examples
The following are example uses of the Email output:
- An analyst configures a real-time analytic to filter events ingested by a feed and sends an email for any features that meet the filter criteria.
- After performing analysis in a real-time analytic, a researcher wants to summarize attributes of the results and send the resulting information in an email.
Usage notes
Keep the following in mind when using the Email output:
- The SMTP server must be externally accessible on the internet.
- It is important to understand the velocity of the data. Each record sent to the output generates a separate email. This could quickly overload the capacity or rate limiting settings of an SMTP server. Do not configure the Email output to send more messages than your SMTP server can handle.
Parameters
The following are the parameters for the Email output:
| Parameter | Description | Data type |
|---|---|---|
SMTP host | The SMTP server that sends 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 the following:
| Not applicable |
Username | The username for the SMTP server. | String |
Password | The password for the SMTP server. | Password |
From email address | The address that appears as the sender of the email. | |
To email address | The email recipient. Access feature attribute values by enclosing them in the token sequence: $${$feature.to_email_address} When sending an email to multiple recipients, use a comma-separated list of their email addresses—for example, $${$feature.to_first_email},$${$feature.to_second_email}. | Email, Arcade single-line text |
Subject | The subject of the email. Access feature attribute values by enclosing them in the token sequence: $${$feature.subject_line} The subject can be configured in a single-line Arcade expression—for example, New incident detected: $${$feature.incident_id}. | String, Arcade single-line 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} Use an Arcade expression by encoding it in the following token sequence: $${functionName}—for example, $${TextFormatting.NewLine}. | String, Arcade multiline text |