community.general.sendgrid – Sends an email with the SendGrid API

Note

This plugin is part of the community.general collection (version 1.3.6).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.sendgrid.

Synopsis

  • Sends an email with a SendGrid account through their API, not through the SMTP service.

Requirements

The below requirements are needed on the host that executes this module.

  • sendgrid Python library 1.6.22 or lower (Sendgrid API V2 supported)

Parameters

Parameter Choices/Defaults Comments
api_key
string
Sendgrid API key to use instead of username/password.
attachments
list / elements=string
A list of relative or explicit paths of files you want to attach (7MB limit as per SendGrid docs).
bcc
list / elements=string
A list of email addresses to bcc.
body
string / required
The e-mail body content.
cc
list / elements=string
A list of email addresses to cc.
from_address
string / required
The address in the "from" field for the email.
from_name
string
The name you want to appear in the from field, i.e 'John Doe'.
headers
dictionary
A dict to pass on as headers.
html_body
boolean
    Choices:
  • no ←
  • yes
Whether the body is html content that should be rendered.
password
string
Password that corresponds to the username.
Since 2.2 it is only required if api_key is not supplied.
subject
string / required
The desired subject for the email.
to_addresses
list / elements=string / required
A list with one or more recipient email addresses.
username
string
Username for logging into the SendGrid account.
Since 2.2 it is only required if api_key is not supplied.

Notes

Note

  • This module is non-idempotent because it sends an email through the external API. It is idempotent only in the case that the module fails.

  • Like the other notification modules, this one requires an external dependency to work. In this case, you’ll need an active SendGrid account.

  • In order to use api_key, cc, bcc, attachments, from_name, html_body, headers you must pip install sendgrid

  • since 2.2 username and password are not required if you supply an api_key

Examples

- name: Send an email to a single recipient that the deployment was successful
  community.general.sendgrid:
    username: "{{ sendgrid_username }}"
    password: "{{ sendgrid_password }}"
    from_address: "[email protected]"
    to_addresses:
      - "[email protected]"
    subject: "Deployment success."
    body: "The most recent Ansible deployment was successful."
  delegate_to: localhost

- name: Send an email to more than one recipient that the build failed
  community.general.sendgrid:
      username: "{{ sendgrid_username }}"
      password: "{{ sendgrid_password }}"
      from_address: "[email protected]"
      to_addresses:
        - "[email protected]"
        - "[email protected]"
      subject: "Build failure!."
      body: "Unable to pull source repository from Git server."
  delegate_to: localhost

Authors

  • Matt Makai (@makaimc)