|
|
@ -24,33 +24,34 @@ version_added: "2.0"
|
|
|
|
module: sendgrid
|
|
|
|
module: sendgrid
|
|
|
|
short_description: Sends an email with the SendGrid API
|
|
|
|
short_description: Sends an email with the SendGrid API
|
|
|
|
description:
|
|
|
|
description:
|
|
|
|
- Sends an email with a SendGrid account through their API, not through
|
|
|
|
- "Sends an email with a SendGrid account through their API, not through
|
|
|
|
the SMTP service.
|
|
|
|
the SMTP service."
|
|
|
|
notes:
|
|
|
|
notes:
|
|
|
|
- This module is non-idempotent because it sends an email through the
|
|
|
|
- "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.
|
|
|
|
external API. It is idempotent only in the case that the module fails."
|
|
|
|
- Like the other notification modules, this one requires an external
|
|
|
|
- "Like the other notification modules, this one requires an external
|
|
|
|
dependency to work. In this case, you'll need an active SendGrid
|
|
|
|
dependency to work. In this case, you'll need an active SendGrid
|
|
|
|
account.
|
|
|
|
account."
|
|
|
|
options:
|
|
|
|
options:
|
|
|
|
username:
|
|
|
|
username:
|
|
|
|
description:
|
|
|
|
description:
|
|
|
|
username for logging into the SendGrid account
|
|
|
|
- username for logging into the SendGrid account
|
|
|
|
required: true
|
|
|
|
required: true
|
|
|
|
password:
|
|
|
|
password:
|
|
|
|
description: password that corresponds to the username
|
|
|
|
description:
|
|
|
|
|
|
|
|
- password that corresponds to the username
|
|
|
|
required: true
|
|
|
|
required: true
|
|
|
|
from_address:
|
|
|
|
from_address:
|
|
|
|
description:
|
|
|
|
description:
|
|
|
|
the address in the "from" field for the email
|
|
|
|
- the address in the "from" field for the email
|
|
|
|
required: true
|
|
|
|
required: true
|
|
|
|
to_addresses:
|
|
|
|
to_addresses:
|
|
|
|
description:
|
|
|
|
description:
|
|
|
|
a list with one or more recipient email addresses
|
|
|
|
- a list with one or more recipient email addresses
|
|
|
|
required: true
|
|
|
|
required: true
|
|
|
|
subject:
|
|
|
|
subject:
|
|
|
|
description:
|
|
|
|
description:
|
|
|
|
the desired subject for the email
|
|
|
|
- the desired subject for the email
|
|
|
|
required: true
|
|
|
|
required: true
|
|
|
|
|
|
|
|
|
|
|
|
author: "Matt Makai (@makaimc)"
|
|
|
|
author: "Matt Makai (@makaimc)"
|
|
|
|