Element details

type: meya.sendgrid.component.send
class: SendgridSendComponent
path: /meya/sendgrid/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	Reference path to the Sendgrid integration element to use to send an email.	◉	○		SendgridIntegrationRef
reply_to	A list of recipients that will be included in the `Reply-To` header.	○	○	null	list
attachments	A list of URLs to files that will be downloaded and attached tothe email. Each file must be less than 10MB. The MIME type of the file will be determined by the file, but if the MIME type could not be determined, it will default to `application/octet-stream`.	○	○	null	list

Usage reference

Basic

triggers:
  - keyword: meya.sendgrid.component.send
steps:
  - type: meya.sendgrid.component.send
    from:
      email: STRING
    to:
      - email: STRING
    integration: integration.sendgrid

Full

triggers:
  - keyword: meya.sendgrid.component.send
steps:
  - type: meya.sendgrid.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.sendgrid
    reply_to:
      - email: STRING
        name: STRING
    attachments:
      - STRING