Send an Email

The Send an Email Output Connector can be used to send a formatted message containing data from processed event data as an email. Messages can be structured as plain text or as HTML and are sent as a request to a configured SMTP server to generate the email for the identified recipients.

Usage notes

• This output connector takes a event data, adapts its event data to construct a message as plain text or HTML, and then sends the message to an independent SMTP server as a request for it to generate the outgoing email.
• This output connector pairs the Message Formatter Outbound Adapter with the SMTP Outbound Transport.
• The event count reported the output in GeoEvent Manager indicates the message containing event data has been sent to the specified SMTP server for delivery to the identified recipients. It does not indicate the success or failure of the SMTP server to create and send the email.
• An email requires a sender and a recipient; however, carbon copy and blind carbon copy recipients are optional.
• Contact your IT administrator to identify the host name, port, and authentication mode of your organization’s SMTP server. For example, port 25 is the well-known port for SMTP, but other ports may be in use by your organization.
• A new default SMTP server host name, port number, authentication mode, username, and password can be specified in the SMTP settings as part of GeoEvent Manager’s global settings. By defining default values for each SMTP property, any newly configured output using the SMTP Outbound Transport such as the Send an Email Output Connector will display the correct information.

Parameters

Parameter	Description
Name	A descriptive name for the output connector used for reference in GeoEvent Manager.
Sender’s Email Address	The email address of the sender. The email address can be provided directly as a string of text or it can be dynamically obtained from a field in the event data using ${FIELD-NAME}. There is no default for this property.
Email Recipient(s)	The email address of the recipient(s). If there are multiple recipients, provide a comma separated list of the email addresses. The email address(es) can be dynamically obtained from a field in the event data using ${FIELD-NAME}. There is no default for this property.
Email Recipient(s) (carbon copy)	The email address of the recipient(s) for blind carbon copy. If there are multiple recipients for blind carbon copy, provide a comma separated list of the email addresses. The email address(es) can be dynamically obtained from a field in the event data using ${FIELD-NAME}. There is no default for this property.
Email Recipient(s) (blind carbon copy)	The email address of the recipient(s) for blind carbon copy. If there are multiple recipients for blind carbon copy, provide a comma separated list of the email addresses. The email address(es) can be dynamically obtained from a field in the event data using ${FIELD-NAME}. There is no default for this property.
Mail Subject	The subject of the email. The email subject can be dynamically obtained from a field in the event data using ${FIELD-NAME}. There is no default for this property.
Message Format	Specifies the format of the email message. Available options include Text and HTML. The default for this property is Text. Text—The email will be formatted as plain text. HTML—The email will be formatted a HTML.
Message Body	The message body of the email. Fields from the processed event data can be used to reference specific values in the outbound email message body. The default for this property is a placeholder string, Enter Message Body Here. Example: A message structured like “Driver, ${DRIVER}, was going ${SPEED} miles per hour at ${TIME}” would return as “Driver, John Doe, was going 82 miles per hour at 14:25:30” in an outbound email.
SMTP Server Host Name	Specifies the SMTP server host name. This is the SMTP server to use for sending email messages. The default is a placeholder string, smtp.HOST-NAME.com.
SMTP Server Port Number	Specifies the SMTP server port number. This is the port that the SMTP server receives on. The default is 25.
SMTP Authentication Mode	Specifies the SMTP server authentication mode. Available authentication modes include Anonymous, SSL, and TLS. The default property is Anonymous. Anonymous—The SMTP server accepts anonymous authentication. Requests issued to the SMTP server by GeoEvent Server will be anonymous. A username and password are not required. SSL—The SMTP server accepts SSL authentication. Requests issued to the SMTP server by GeoEvent Server will be done over SSL. A SMTP authenticated username and password are required for sending the email. TLS—The SMTP server accepts TLS authentication. Requests issued to the SMTP server by GeoEvent Server will be done over TLS. A SMTP authenticated username and password are required for sending the email.
Username (Conditional)	Specifies the SMTP authenticated user responsible for sending the email. The default for this property is a placeholder string, MyUsername. Property is shown when SMTP authentication mode is set to SSL or TLS and is hidden when set to Anonymous.
Password (Conditional)	Specifies the password of the SMTP authenticated user sending the email. There is no default for this property. Property is shown when SMTP Authentication Mode is set to SSL or TLS and is hidden when set to Anonymous.