Breadcrumbs

Email - Send Message

Overview

Send a message to anyone in the world using email.

To have Workflows dynamically parse and output the contents of a file, you can include the filename in the following format: {{text:file.txt}}

Variables

Name

Reference

Type

Required

Default

Options

Description

Sender Name

EMAIL_SENDER_NAME

Alphanumeric

None

-

The name you want users to see that the email is from. If left blank, the Sender Address will be used.

To

EMAIL_TO

Alphanumeric

None

-

The email(s) that you want to send a message to. Can be comma-separated to include multiple email addresses.

CC

EMAIL_CC

Alphanumeric

None

-

The email(s) that you want your message to be carbon copied (CCed) to. Can be comma-separated to include multiple email addresses.

BCC

EMAIL_BCC

Alphanumeric

None

-

The email(s) that you want to be blind carbon copied (BCCed) to. Can be comma-separated to include multiple email addresses. Emails in this field will receive the email, but will not have their email exposed to all other recipients.

Subject

EMAIL_SUBJECT

Alphanumeric

None

-

The subject of the email that you want to send.

Message

EMAIL_MESSAGE

Alphanumeric

None

-

The body of the email, containing your main message. This field supports plain text as well as HTML. To have Workflows dynamically parse and output the contents of a file, you can include the filename in this format: {{text:file.txt}}

Include Workflows Footer?

EMAIL_INCLUDE_SHIPYARD_FOOTER

Boolean

TRUE

-

Determines if a footer should be sent with the email that links back to the originating Task or Workflow.

YAML

Below is the YAML template

YAML

source:
  template: Email - Send Message
  inputs:
    EMAIL_SENDER_NAME:
    EMAIL_TO:
    EMAIL_CC:
    EMAIL_BCC:
    EMAIL_SUBJECT:
    EMAIL_MESSAGE:
    EMAIL_INCLUDE_SHIPYARD_FOOTER: 'TRUE'
  type: TEMPLATE
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - 102
    - 104
    - 200
    - 201
    - 203