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:

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.

The value stored in the From field must match the Email and Public ID fields in an existing VMP user definition. See Adding Users Manually for more information on the fields that can be specified for a VMP user.

To:

A list of one or more recipient email addresses.

The value stored in the To field must match the Public ID field in an existing VMP user definition, or the Distribution List ID field in an existing VMP Distribution List definition. See Adding Users Manually for more information on the fields that can be specified for a VMP user, and see Creating a Regular or On-Call Distribution List for more information on creating a Distribution List.

Subject:

The message subject.

Message:

The body of the message.

Priority:

The message priority. Must be one of Normal or High. To specify Urgent priority, set Priority to High and set OverridePersonalAlarmSettings to true. For Normal or High priority, OverridePersonalAlarmSettings must be set to false.

OverridePersonalAlarmSettings:

Whether the message should force the recipient's device to emit a tone and vibration. Valid options are true and false. See the description of Priority above.

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:

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.