community.general.sendgrid – Sends an email with the SendGrid API¶
Note
This plugin is part of the community.general collection (version 2.5.1).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.sendgrid
.
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¶
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)