The definition of a complete message to be sent by Mapp Engage. The properties provided determine what type of message is sent. Message types include:
Simple MIME messages (text or HTML part).
Multipart alternative MIME messages (text and HTML).
Multipart-mixed MIME messages.
Message attachments are referenced from the Content Store.
Name | Type | Description | Constraints |
---|---|---|---|
sendoutRef | An ID assigned to the sendout. Where possible, use a number. Only characters A-Z and 0-9 are allowed. This property is not available for API versions 6 and higher. | required | |
recipientRef | An ID assigned to the message recipient. Where possible, use a number. Only characters A-Z and 0-9 are allowed. This property is not available for API versions 6 and higher. | required | |
from | The From address of the email in RFC-822 format. For API versions 6 and higher, this property is restricted to the format "localpart@domain". | required | |
fromName | The name displayed in the email client as the From address in the email. This property is not available for API versions 6 and higher. | required | |
to | The To address of the email or comma-separated list of email addresses in RFC-822 format. For API versions lower than version 6, this property is restricted to a single email address with the format "localpart@domain". API versions 6 and higher can enter a comma-separated list of recipients. The To address is required for each recipient. A name is optional. Enter addresses in the correct format recognized by the email header. An email address with name is entered as: "Joe Sample" <joe.sample@email.com>. This property is required. | required | |
cc | The CC address of the email or comma-separated list of email addresses in RFC-822 format. This property is only available for API versions 6 and higher. This property is optional. | required | |
bcc | The BCC address of the email or comma-separated list of email addresses in RFC-822 format. This property is only available for API versions 6 and higher. This property is optional. | required | |
toName | The name displayed in the email client for the To address. This property is not available for API versions 6 and higher. API versions 6 and higher enter this value as part of the "to" property. | required | |
replyTo | The Reply-To email address in RFC-822 format. For API versions 6 and higher, this property is restricted to a single email address with the format "localpart@domain". | required | |
replyToName | The name displayed in the email client for the Reply-To email address. This property is not available for API versions 6 and higher. | required | |
headers | Additional email headers that are added to the message. | required | |
subject | The message subject. | required | |
textBody | The text body part of the message. | required | |
htmlBody | The HTML body part of the message. | required | |
attachmentReferences | AttachmentReference[] | A list of references to images and attachments saved to the Content Store. | required |
attachments | A list of attachments. | required |