Last Update: 2024-03-21
<?xml version="1.0" encoding="utf-8"?>
<newsletter-send-transactional id="" externalid="" response="">
<!-- Variant 1) Send to existing address (specified by key-field) //-->
<address key="" type=""></address>
...
<!-- Variant 2) Create/Update address //-->
<addressinsert type=""></addressinsert>
...
<allow-address-error></allow-address-error>
<ignore-address-status></ignore-address-status>
<ignore-blacklist></ignore-blacklist>
<senddatetime></senddatetime>
<fromemail></fromemail>
<fromname></fromname>
<replyto></replyto>
<accountmanager></accountmanager>
<content>
<value key=""></value>
...
</content>
<attachments>
<attachment type="" name="">https://...</attachment>
...
</attachments>
</newsletter-send-transactional>
| Element | Format | Description |
|---|---|---|
newsletter-send-transactional | ||
↳ @id | int | ID of newsletter |
↳ @externalid | int | External ID of newsletter (overruled by ID if given) |
↳ @response | simple|complex | simple(default): returns ID of created job only; complex: returns additionaly response for each address |
↳ testemail | If defined, the mail will only be sent to this email but personalized for the first real address | |
↳ address | Add recipient from an existing address | |
↳ @key | varchar | Key-field by which the address is specified |
↳ @type | to|cc | default=to |
↳ addressinsert | Add recipient by creating/updateing an address (info) | |
↳ @type | to|cc | default=to |
↳ allow-address-error | to|cc|all|no | Default=no; Send mailing even if some addresses had an error (e.g. when set to "cc", not all cc-adresses need to be valid) |
↳ ignore-address-status | 0|1 | Default=0; Also send if address is not subscribed |
↳ ignore-blacklist | 0|1 | Default=0; Also send if address is blacklisted |
↳ senddatetime | YYYY-mm-dd HH:ii:ss | Optional to schedule sending |
↳ fromemail | varchar(255) | Override from email of newsletter |
↳ fromname | varchar(255) | Override from name of newsletter |
↳ replyto | varchar(255) | Override reply-to email of newsletter |
↳ accountmanager | ID of accountmanager to override the accountmangager of each address | |
↳ content | List of address specific content | |
↳ value | text | Content value |
↳ @key | varchar(255) | Content keyword (used as placeholder variable) |
↳ attachments | List of address specific attachments | |
↳ attachment | Attachment data | |
↳ @type | url|base64 | Attachment data is fetched by given url or is directly given as base64 encoded string. |
↳ @name | varchar | Filename of attachment |
senddatetime (e.g. "2019-07-26 08:45:00") is used if the timezone is "Europe/Vienna". Additional valid formats are "UTC 2019-07-26T08:45:00.000Z" or "2019-07-26T08:45:00+00:00".
On success the internal ID of the created job will be returned in response->data.