MailExecution
Send an email with the execution information.

Send an email with the execution information.

The message will include a link to the execution page in the UI along with the execution ID, namespace, flow name, the start date, duration, and the final status of the execution. If the task failed, then the task that led to the failure is specified.

Use this notification task only in a flow that has a Flow trigger, as shown in this example. Don't use this notification task in errors tasks. Instead, for errors tasks, use the MailSend task.

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

Examples

Send an email notification on a failed flow execution

yaml

id: failure_alert
namespace: company.team

tasks:
  - id: send_alert
    type: io.kestra.plugin.notifications.mail.MailExecution
    to: [email protected]
    from: [email protected]
    subject: "The workflow execution {{trigger.executionId}} failed for the flow {{trigger.flowId}} in the namespace {{trigger.namespace}}"
    host: mail.privateemail.com
    port: 465
    username: "{{ secret('EMAIL_USERNAME') }}"
    password: "{{ secret('EMAIL_PASSWORD') }}"
    executionId: "{{ trigger.executionId }}"

triggers:
  - id: failed_prod_workflows
    type: io.kestra.plugin.core.trigger.Flow
    conditions:
      - type: io.kestra.plugin.core.condition.ExecutionStatus
        in:
          - FAILED
          - WARNING
      - type: io.kestra.plugin.core.condition.ExecutionNamespace
        namespace: prod
        prefix: true

Properties

attachmentsarraystring

Adds an attachment to the email message

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

ccstring

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

customFieldsobject

Custom fields to be added on notification

customMessagestring

Custom message to be added on notification

embeddedImagesarraystring

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.

executionIdstring

Default{{ execution.id }}

The execution id to use

Default is the current execution, change it to if you use this task with a Flow trigger to use the original execution.

fromstring

The address of the sender of this email

hoststring

The email server host

passwordstring

The email server password

plainTextContentstring

The optional email message body in plain text

Both text and HTML can be provided; either will be offered to the email client as alternative content. Email clients that support it, will favor HTML over plain text and ignore the text body completely.

portintegerstring

The email server port

sessionTimeoutintegerstring

Default10000

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

It controls the maximum timeout value when sending emails.

subjectstring

The optional subject of this email

templateRenderMapobject

Map of variables to use for the message template

tostring

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.

transportStrategystring

DefaultSMTPS

Possible Values

SMTPSMTPSSMTP_TLSSMTP_OAUTH2

The optional transport strategy

Will default to SMTPS if left empty

trustedHostsarray

SubTypestring

Trusted SSL/TLS hosts

If provided, only the specified hosts will be trusted for SSL/TLS connections

usernamestring

The email server username

verifyServerIdentitybooleanstring

Defaulttrue

Whether to verify the server identity

Will default to true if left empty

Azure

Enterprise

Leverage Microsoft Azure services within Kestra data workflows.

AlertingCloudStorageBatch

ServiceNow

This sub-group of plugins contains tasks for using ServiceNow. ServiceNow allows employees to work the way they want to, not how software dictates they have to.

Alerting