Send an email from an action. Delivery is over SMTP — configure it with an smtp
block, then set from, to (plus optional cc, bcc, reply_to), subject,
and an html or text body.
actions:
- name: SendWelcome
email:
smtp:
server: smtp.example.com
port: 587
user: a|secret::smtp_user|
pass: a|secret::smtp_pass|
from: [email protected]
to: a|body::email|
subject: Welcome
html: "<h1>Welcome aboard</h1>"
Email
| Field | Type | Description |
|---|---|---|
aws_ses | boolean (nullable) | |
smtp | EmailSmtp (nullable) | |
from | string | Required. |
reply_to | string (nullable) | |
to | string | Required. |
cc | string (nullable) | |
bcc | string (nullable) | |
rows | string (nullable) | Batch mode. An interpolation ref resolving to a JSON array of row objects (e.g. a|Fired|). When set, one email is sent per row: each row's string fields to / subject /… |
subject | string | Required. |
header | string (nullable) | |
html | string (nullable) | |
text | string (nullable) | |
params | Array<string> (nullable) | |
attachments | Array<EmailAttachment> (nullable) | Files to attach. Turns the message into a multipart/mixed — the html/text body stays the first part and each attachment follows. Example ↓ |
success_message | string (nullable) | |
error_message | string (nullable) |
Field examples
attachments
Files to attach. Turns the message into a multipart/mixed — the html/text
body stays the first part and each attachment follows.
Example
attachments:
- filename: signups.csv
content: a|BuildCsv::csv_b64| # base64 (see `b64_encode`)
content_type: text/csv
EmailSmtp
| Field | Type | Description |
|---|---|---|
user | string | Required. |
pass | string | Required. |
server | string | Required. |
port | number (nullable) | |
tls | boolean (nullable) |