mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 20:31:27 -07:00
s[e-n]*: normalize docs (#9352)
* s[e-n]*: normalize docs * Apply suggestions from code review Co-authored-by: Felix Fontein <felix@fontein.de> * quote line with : and remove extraneous notes * Update plugins/modules/slack.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/seport.py Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
bef82e28a2
commit
9fc3092bb3
20 changed files with 627 additions and 689 deletions
|
@ -9,21 +9,15 @@ from __future__ import absolute_import, division, print_function
|
|||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: sendgrid
|
||||
short_description: Sends an email with the SendGrid API
|
||||
description:
|
||||
- "Sends an email with a SendGrid account through their API, not through
|
||||
the SMTP service."
|
||||
- Sends an email with a SendGrid account through their API, not through the SMTP service.
|
||||
notes:
|
||||
- "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"
|
||||
- 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 will need an active SendGrid account.
|
||||
- In order to use O(api_key), O(cc), O(bcc), O(attachments), O(from_name), O(html_body), and O(headers) you must C(pip install sendgrid).
|
||||
requirements:
|
||||
- sendgrid Python library 1.6.22 or lower (Sendgrid API V2 supported)
|
||||
extends_documentation_fragment:
|
||||
|
@ -98,9 +92,9 @@ options:
|
|||
- The e-mail body content.
|
||||
required: true
|
||||
author: "Matt Makai (@makaimc)"
|
||||
'''
|
||||
"""
|
||||
|
||||
EXAMPLES = r'''
|
||||
EXAMPLES = r"""
|
||||
- name: Send an email to a single recipient that the deployment was successful
|
||||
community.general.sendgrid:
|
||||
username: "{{ sendgrid_username }}"
|
||||
|
@ -114,16 +108,16 @@ EXAMPLES = r'''
|
|||
|
||||
- name: Send an email to more than one recipient that the build failed
|
||||
community.general.sendgrid:
|
||||
username: "{{ sendgrid_username }}"
|
||||
password: "{{ sendgrid_password }}"
|
||||
from_address: "build@mycompany.com"
|
||||
to_addresses:
|
||||
- "ops@mycompany.com"
|
||||
- "devteam@mycompany.com"
|
||||
subject: "Build failure!."
|
||||
body: "Unable to pull source repository from Git server."
|
||||
username: "{{ sendgrid_username }}"
|
||||
password: "{{ sendgrid_password }}"
|
||||
from_address: "build@mycompany.com"
|
||||
to_addresses:
|
||||
- "ops@mycompany.com"
|
||||
- "devteam@mycompany.com"
|
||||
subject: "Build failure!."
|
||||
body: "Unable to pull source repository from Git server."
|
||||
delegate_to: localhost
|
||||
'''
|
||||
"""
|
||||
|
||||
# =======================================
|
||||
# sendgrid module support methods
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue