TransactionalSendMessage
Send a new transactional message through the Transactional API.
Stored Procedure Specific Information
This stored procedure requires a premium membership to Mailchimp.The To input is required. For example:
exec TransactionalSendMessage To = '[{ \"email\" : \"[email protected]\" , \"name\" : \"ABC\", \"type\" : \"to\"}]';
Alternatively, you can provide ToEmails, CcEmails or BccEmails to create a message:
exec TransactionalSendMessage ToEmails='[email protected],[email protected],[email protected]', ToNames='XYZ,,ABC', CcEmails='[email protected],[email protected]'
Input
| Name | Type | Required | Accepts Input Streams | Description |
| Html | String | False | False | The full HTML content to be sent. |
| Text | String | False | False | The optional full text content to be sent. |
| Subject | String | False | False | The message subject. |
| FromEmail | String | False | False | The sender's email address. |
| FromName | String | False | False | The optional from name to be used. |
| To | String | False | False | An array of recipient information. |
| ToEmails | String | False | False | A comma-separated list of email addresses for type 'to'. |
| ToNames | String | False | False | A comma-separated list of names for type 'to'. |
| CcEmails | String | False | False | A comma-separated list of email addresses for type 'cc'. |
| CcNames | String | False | False | A comma-separated list of names for type 'cc'. |
| BccEmails | String | False | False | A comma-separated list of email addresses for type 'bcc'. |
| BccNames | String | False | False | A comma-separated list of names for type 'bcc'. |
| Headers | String | False | False | The optional extra headers to add to the message. |
| Important | Boolean | False | False | Indicates whether this message is important and should be delivered ahead of non-important messages. |
| TrackOpens | Boolean | False | False | Indicates whether to turn on open tracking for the message. |
| TrackClicks | Boolean | False | False | Indicates whether to turn on click tracking for the message. |
| AutoText | Boolean | False | False | Indicates whether to automatically generate a text part for messages that are not given text. |
| AutoHtml | Boolean | False | False | Indicates whether to automatically generate an HTML part for messages that are not given HTML. |
| InlineCss | Boolean | False | False | Indicates whether to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size. |
| UrlStripQs | Boolean | False | False | Indicates whether to strip the query string from URLs when aggregating tracked URL data. |
| PreserveRecipients | Boolean | False | False | Indicates whether to expose all recipients in to 'To' header for each email. |
| ViewContentLink | Boolean | False | False | Set to false to remove content logging for sensitive emails. |
| BccAddress | String | False | False | An optional address to receive an exact copy of each recipient's email. |
| TrackingDomain | String | False | False | A custom domain to use for tracking opens and clicks instead of mandrillapp.com. |
| SigningDomain | String | False | False | A custom domain to use for SPF/DKIM signing instead of mandrill. |
| ReturnPathDomain | String | False | False | A custom domain to use for the messages's return-path. |
| Merge | Boolean | False | False | Indicates whether to evaluate merge tags in the message. |
| MergeLanguage | String | False | False | The merge tag language to use when evaluating merge tags, either mailchimp or handlebars.
The allowed values are mailchimp, handlebars. |
| GlobalMergeVars | String | False | False | The global merge variables to use for all recipients. |
| MergeVars | String | False | False | The per-recipient merge variables, which override global merge variables with the same name. |
| Tags | String | False | False | An array of string to tag the message with. |
| Subaccount | String | False | False | The unique Id of a subaccount for this message. The message must already exist. |
| GoogleAnalyticsDomains | String | False | False | An array of strings indicating which matching URLs have Google Analytics parameters appended to their query string automatically. |
| GoogleAnalyticsCampaign | String | False | False | An optional string indicating the value to set for the utm_campaign tracking parameter. |
| Metadata | String | False | False | An associative array of user metadata. |
| RecipientMetadata | String | False | False | The per-recipient metadata that overrides the global values specified in the metadata parameter. |
| Attachments | String | False | False | An array of supported attachments to add to the message. |
| AttachmentLocations | String | False | False | The comma-separated values of file location of attachments. |
| AttachmentContent | String | False | True | The content of a single attachment. |
| AttachmentName | String | False | False | The name of the attachment for which the content is sent in AttachmentContent. |
| Images | String | False | False | An array of embedded images to add to the message. |
| ImageLocations | String | False | False | The comma-separated values of file location of images. |
| ImageContent | String | False | True | The content of a single image. |
| ImageName | String | False | False | The name of the image for which the content is sent in ImageContent. |
| Async | Boolean | False | False | Enables a background sending mode that is optimized for bulk sending. |
| IpPool | String | False | False | The name of the dedicated IP pool that should be used to send the message. |
| SendAt | Datetime | False | False | When this message should be sent, as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. |
Result Set Columns
| Name | Type | Description |
| Success | String | Indicates whether the operation was successful. |
| Id | String | The message's unique Id. |
| String | The email address of the recipient. | |
| Status | String | The sending status of the recipient. |
| RejectReason | String | The reason for the rejection if the recipient status is 'rejected'. |
| QueuedReason | String | A string that uniquely identifies the campaign associated with a cart. |