PluginsNotificationsTasksMailMailSend

MailSend​Mail​Send

MailSend MailSend

yaml
type: "io.kestra.plugin.notifications.mail.MailSend"

Send an automated email from a workflow

Examples

Send an email on a failed flow execution

yaml
id: unreliable_flow
namespace: prod

tasks:
  - id: fail
    type: io.kestra.plugin.scripts.shell.Commands
    runner: PROCESS
    commands:
      - exit 1

errors:
  - id: send_email
    type: io.kestra.plugin.notifications.mail.MailSend
    from: [email protected]
    to: [email protected]
    username: "{{ secret('EMAIL_USERNAME') }}"
    password: "{{ secret('EMAIL_PASSWORD') }}"
    host: mail.privateemail.com
    port: 465 # or 587
    subject: "Kestra workflow failed for the flow {{flow.id}} in the namespace {{flow.namespace}}"
    htmlTextContent: "Failure alert for flow {{ flow.namespace }}.{{ flow.id }} with ID {{ execution.id }}"

Properties

attachments

Adds an attachment to the email message

The attachment will be shown in the email client as separate files available for download, or displayed inline if the client supports it (for example, most browsers display PDF's in a popup window)

cc

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

One or more 'Cc' (carbon copy) optional recipient email address. Use semicolon as delimiter to provide several addresses

Note that each email address must be compliant with the RFC2822 format

embeddedImages

Adds image data to this email that can be referred to from the email HTML body

The provided images are assumed to be of MIME type png, jpg or whatever the email client supports as valid image that can be embedded in HTML content

from

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The address of the sender of this email

host

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The email server host

htmlTextContent

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The optional email message body in HTML text

Both text and HTML can be provided, which will be offered to the email client as alternative contentEmail clients that support it, will favor HTML over plain text and ignore the text body completely

password

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The email server password

port

  • Type: integer
  • Dynamic: ✔️
  • Required: ❌

The email server port

sessionTimeout

  • Type: integer
  • Dynamic: ❓
  • Required: ❌
  • Default: 10000

Integer value in milliseconds. Default is 10000 milliseconds, i.e. 10 seconds

It controls the maximum timeout value when sending emails

subject

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The optional subject of this email

to

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Email address(es) of the recipient(s). Use semicolon as delimiter to provide several email addresses

Note that each email address must be compliant with the RFC2822 format

transportStrategy

  • Type: string
  • Dynamic: ❓
  • Required: ❌
  • Default: SMTPS
  • Possible Values:
    • SMTP
    • SMTPS
    • SMTP_TLS
    • SMTP_OAUTH2

The optional transport strategy

Will default to SMTPS if left empty

username

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The email server username

Definitions

io.kestra.plugin.notifications.mail.MailSend-Attachment

Properties

contentType
  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Default: application/octet-stream

One or more 'Cc' (carbon copy) optional recipient email address(es). Use semicolon as a delimiter to provide several addresses

Note that each email address must be compliant with the RFC2822 format

name
  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

The name of the attachment (eg. 'filename.txt')

uri
  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

An attachment URI from Kestra internal storage