Mail Executor

Send emails from your workflows for notifications, alerts, and reports.

Basic Usage

smtp:
  host: "smtp.gmail.com"
  port: "587"
  username: "${SMTP_USER}"
  password: "${SMTP_PASS}"

steps:
  - executor:
      type: mail
      config:
        to: [email protected]
        from: [email protected]
        subject: "Workflow Completed"
        message: "The data processing workflow has completed successfully."

SMTP Configuration

Common Providers

# Gmail
smtp:
  host: "smtp.gmail.com"
  port: "587"
  username: "[email protected]"
  password: "app-specific-password"  # Not regular password

# Office 365
smtp:
  host: "smtp.office365.com"
  port: "587"
  username: "${SMTP_USER}"
  password: "${SMTP_PASS}"

# AWS SES
smtp:
  host: "email-smtp.us-east-1.amazonaws.com"
  port: "587"
  username: "${AWS_SES_SMTP_USER}"
  password: "${AWS_SES_SMTP_PASSWORD}"

Examples

Multiple Recipients

steps:
  - executor:
      type: mail
      config:
        to:
          - [email protected]
          - [email protected]
          - [email protected]
        from: [email protected]
        subject: "Daily Report Ready"
        message: "The daily report has been generated."
        
  - executor:
      type: mail
      config:
        to: [email protected]  # Single recipient still works
        from: [email protected]
        subject: "System Update"
        message: "System maintenance completed."

With Variables

params:
  - ENVIRONMENT: production

steps:
  - executor:
      type: mail
      config:
        to: [email protected]
        from: [email protected]
        subject: "Deployed to ${ENVIRONMENT}"
        message: |
          Deployment completed:
          - Environment: ${ENVIRONMENT}
          - Version: ${VERSION}
          - Time: `date`

Success/Failure Notifications

handlerOn:
  success:
    executor:
      type: mail
      config:
        to: [email protected]
        from: [email protected]
        subject: "✅ Pipeline Success - ${DAG_NAME}"
        message: |
          Pipeline completed successfully.
          Run ID: ${DAG_RUN_ID}
          Logs: ${DAG_RUN_LOG_FILE}
  
  failure:
    executor:
      type: mail
      config:
        to: [email protected]
        from: [email protected]
        subject: "❌ Pipeline Failed - ${DAG_NAME}"
        message: |
          Pipeline failed.
          Run ID: ${DAG_RUN_ID}
          Check logs: ${DAG_RUN_LOG_FILE}

steps:
  - echo "Run your main tasks here"

Error Alerts

errorMail:
  from: [email protected]
  to: [email protected]
  prefix: "[CRITICAL]"
  attachLogs: true

steps:
  - command: echo "Run some critical task"
    mailOnError: true

With Attachments

steps:
  - echo "Generating report..." > report.txt

  - executor:
      type: mail
      config:
        to: [email protected]
        from: [email protected]
        subject: "Weekly Report"
        message: "Please find the weekly report attached."
        attachments:
          - report.txt

With Retry

steps:
  - executor:
      type: mail
      config:
        to: [email protected]
        from: [email protected]
        subject: "Critical Alert"
        message: "Immediate action required."
    retryPolicy:
      limit: 3
      intervalSec: 60