Learn more: https://postmarkapp.com/developer/api/email-api#send-a-single-email
Element details
type: meya.postmark.component.send
class: PostmarkSendComponent
path: /meya/postmark/component/send.py
signature: -
Fields
field | description | required | signature | default | type |
---|---|---|---|---|---|
spec | Override the original spec for this element. | ○ | ○ | null | Spec |
context | Send context data with this component's event. | ○ | ○ | {} | dict |
sensitive | ○ | ○ | true | bool | |
triggers | Activate these dynamic triggers when the component runs. Check the component triggers guide for more info. | ○ | ○ | [] | list |
from | The sender of the email. Depending on the integration, this might need to be a verified email address. | ◉ | ○ | Recipient | |
to | A list of recipients that will receive the email. | ◉ | ○ | list | |
cc | A list of recipients that will receive a copy of the email. | ○ | ○ | [] | list |
bcc | A list of recipients that will receive a blind copy of the email. | ○ | ○ | [] | list |
subject | The subject of the email. | ○ | ○ | null | str |
text | The text body of the email. Text bodies are supported by all email clients, and is the fallback if the email client does not support HTML. We recommend that you always include a text body in your emails. | ○ | ○ | null | str |
html | The HTML body of the email. Not all email clients support HTML, so you should always include a text body as a fallback. | ○ | ○ | null | str |
headers | A dictionary of custom email headers to include in the email. | ○ | ○ | null | dict |
wait_for_response | If true , the component will wait for a response from the integration. If false , the component will not wait for a response from the integration and the email will be sent asynchronously. In this case a send failure will only be reported in your app logs and not to the user. | ○ | ○ | true | bool |
integration | ◉ | ○ | PostmarkIntegrationRef | ||
tag | ○ | ○ | null | str | |
reply_to | ○ | ○ | null | str | |
track_opens | ○ | ○ | null | bool | |
track_links | ○ | ○ | null | TrackLinks | |
metadata | ○ | ○ | null | dict | |
attachments | ○ | ○ | null | list | |
message_stream | ○ | ○ | null | str | |
Usage reference
Basic
triggers:
- keyword: meya.postmark.component.send
steps:
- type: meya.postmark.component.send
from:
email: STRING
to:
- email: STRING
integration: integration.postmark
Full
triggers:
- keyword: meya.postmark.component.send
steps:
- type: meya.postmark.component.send
spec:
type: STRING
data:
STRING: ANY
timeout: 123
trigger_when: ANY
context:
STRING: ANY
sensitive: false
triggers:
- type: STRING
data:
STRING: ANY
timeout: 123
trigger_when: ANY
from:
email: STRING
name: STRING
to:
- email: STRING
name: STRING
cc:
- email: STRING
name: STRING
bcc:
- email: STRING
name: STRING
subject: STRING
text: STRING
html: STRING
headers:
foo: bar
wait_for_response: false
integration: integration.postmark
tag: STRING
reply_to: STRING
track_opens: false
track_links: None|HtmlAndText|HtmlOnly|TextOnly
metadata:
foo: bar
attachments:
- name: STRING
content: STRING
content_type: STRING
content_id: STRING
message_stream: STRING