Email Configuration

You can configure the email that is being sent in your airflow.cfg by setting a subject_template and/or a html_content_template in the [email] section.

  1. [email]
  2. email_backend = airflow.utils.email.send_email_smtp
  3. subject_template = /path/to/my_subject_template_file
  4. html_content_template = /path/to/my_html_content_template_file

Equivalent environment variables look like:

  1. AIRFLOW__EMAIL__EMAIL_BACKEND=airflow.utils.email.send_email_smtp
  2. AIRFLOW__EMAIL__SUBJECT_TEMPLATE=/path/to/my_subject_template_file
  3. AIRFLOW__EMAIL__HTML_CONTENT_TEMPLATE=/path/to/my_html_content_template_file

You can configure a sender’s email address by setting from_email in the [email] section like:

  1. [email]
  2. from_email = "John Doe <johndoe@example.com>"

Equivalent environment variables look like:

  1. AIRFLOW__EMAIL__FROM_EMAIL="John Doe <johndoe@example.com>"

To configure SMTP settings, checkout the SMTP section in the standard configuration. If you do not want to store the SMTP credentials in the config or in the environment variables, you can create a connection called smtp_default of Email type, or choose a custom connection name and set the email_conn_id with it’s name in the configuration & store SMTP username-password in it. Other SMTP settings like host, port etc always gets picked up from the configuration only. The connection can be of any type (for example ‘HTTP connection’).

If you want to check which email backend is currently set, you can use airflow config get-value email email_backend command as in the example below.

  1. $ airflow config get-value email email_backend
  2. airflow.utils.email.send_email_smtp

To access the task’s information you use Jinja Templating in your template files.

For example a html_content_template file could look like this:

  1. Try {{try_number}} out of {{max_tries + 1}}<br>
  2. Exception:<br>{{exception_html}}<br>
  3. Log: <a href="{{ti.log_url}}">Link</a><br>
  4. Host: {{ti.hostname}}<br>
  5. Mark success: <a href="{{ti.mark_success_url}}">Link</a><br>

Note

For more information on setting the configuration, see Setting Configuration Options

Send email using SendGrid

Using Default SMTP

You can use the default airflow SMTP backend to send email with SendGrid

  1. [smtp]
  2. smtp_host=smtp.sendgrid.net
  3. smtp_starttls=False
  4. smtp_ssl=False
  5. smtp_user=apikey
  6. smtp_password=<generated-api-key>
  7. smtp_port=587
  8. smtp_mail_from=<your-from-email>

Equivalent environment variables looks like

  1. AIRFLOW__SMTP__SMTP_HOST=smtp.sendgrid.net
  2. AIRFLOW__SMTP__SMTP_STARTTLS=False
  3. AIRFLOW__SMTP__SMTP_SSL=False
  4. AIRFLOW__SMTP__SMTP_USER=apikey
  5. AIRFLOW__SMTP__SMTP_PASSWORD=<generated-api-key>
  6. AIRFLOW__SMTP__SMTP_PORT=587
  7. AIRFLOW__SMTP__SMTP_MAIL_FROM=<your-from-email>

Using SendGrid Provider

Airflow can be configured to send e-mail using SendGrid.

Follow the steps below to enable it:

  1. Setup your SendGrid account, The SMTP and copy username and API Key.

  2. Include sendgrid provider as part of your Airflow installation, e.g.,

  1. pip install 'apache-airflow[sendgrid]' --constraint ...

or

  1. pip install 'apache-airflow-providers-sendgrid' --constraint ...

  1. Update email_backend property in [email] section in airflow.cfg, i.e.

    1. [email]
    2. email_backend = airflow.providers.sendgrid.utils.emailer.send_email
    3. email_conn_id = sendgrid_default
    4. from_email = "hello@eg.com"

    Equivalent environment variables looks like

    1. AIRFLOW__EMAIL__EMAIL_BACKEND=airflow.providers.sendgrid.utils.emailer.send_email
    2. AIRFLOW__EMAIL__EMAIL_CONN_ID=sendgrid_default
    3. SENDGRID_MAIL_FROM=hello@thelearning.dev

  2. Create a connection called sendgrid_default, or choose a custom connection name and set it in email_conn_id of ‘Email’ type. Only login and password are used from the connection.

create email connection

Note

The callbacks for success, failure and retry will use the same configuration to send the email

Send email using AWS SES

Airflow can be configured to send e-mail using AWS SES.

Follow the steps below to enable it:

  1. Include amazon subpackage as part of your Airflow installation:
  1. pip install 'apache-airflow[amazon]'

  1. Update email_backend property in [email] section in airflow.cfg:

    1. [email]
    2. email_backend = airflow.providers.amazon.aws.utils.emailer.send_email
    3. email_conn_id = aws_default
    4. from_email = From email <email@example.com>

Note that for SES, you must configure from_email to the valid email that can send messages from SES.

  1. Create a connection called aws_default, or choose a custom connection name and set it in email_conn_id. The type of connection should be Amazon Web Services.