The Email Body Format

Because the email body is in XML Format, email aliasing and redirection are not required, as the XML document contains all of the necessary information. The following XML tags are supported:

Table 1. Supported XML tags
Tag Description

AlertExternalID:

The ID of the message, as specified by the initiating process or system.

From:

The sender or initiator's name and email address.

To:

A list of one or more recipient email addresses.

Subject:

The message subject.

Message:

The body of the message.

Priority:

The message priority. Must be one of Normal, High, or Urgent.

OverridePersonalAlarmSettings:

Whether the message should force the recipient's device to emit a tone and vibration. Valid options are True and False.

notifyWhenDelivered:

Whether the Delivered status notification should be sent back to the initiator.

notifyWhenRead:

Whether the Read status notification should be sent back to the initiator.

sendResponse:

Whether the initiator should be notified when a recipient sends a response.

notificationEmail:

The email address for status notifications. Overrides the email address specified in the From: tag.

ResponseType:

The response type associated with the message. This is one of the following:

  • None: No response is required.

  • Multi: Recipients must select from one or more responses defined in the message.

Responses:

When ResponseType is set to Multi, this is a container tag for the responses defined for the message. Each response is contained in an EmailPagingAlertResponse, which is defined below.

Each EmailPagingAlertResponse tag contained in the Responses includes the following subtags:

Table 2. EmailPagingAlertResponse subtags
Subtag Description

RspExternalID:

The third-party ID associated with this response. This ID is returned to the initiating system if the recipient selects this response.

Text:

The text that is displayed for this response.