updated docs, version is 2.2 and explain changes
This commit is contained in:
parent
ccec9b1645
commit
1a74d68a37
1 changed files with 30 additions and 12 deletions
|
@ -39,12 +39,16 @@ requirements:
|
||||||
options:
|
options:
|
||||||
username:
|
username:
|
||||||
description:
|
description:
|
||||||
- username for logging into the SendGrid account
|
- username for logging into the SendGrid account.
|
||||||
required: true
|
- Since 2.2 it is only required if api_key is not supplied.
|
||||||
|
required: false
|
||||||
|
default: null
|
||||||
password:
|
password:
|
||||||
description:
|
description:
|
||||||
- password that corresponds to the username
|
- password that corresponds to the username
|
||||||
required: true
|
- Since 2.2 it is only required if api_key is not supplied.
|
||||||
|
required: false
|
||||||
|
default: null
|
||||||
from_address:
|
from_address:
|
||||||
description:
|
description:
|
||||||
- the address in the "from" field for the email
|
- the address in the "from" field for the email
|
||||||
|
@ -60,34 +64,48 @@ options:
|
||||||
api_key:
|
api_key:
|
||||||
description:
|
description:
|
||||||
- sendgrid API key to use instead of username/password
|
- sendgrid API key to use instead of username/password
|
||||||
version_added: 2.1
|
version_added: 2.2
|
||||||
|
required: false
|
||||||
|
default: null
|
||||||
cc:
|
cc:
|
||||||
description:
|
description:
|
||||||
- a list of email addresses to cc
|
- a list of email addresses to cc
|
||||||
version_added: 2.1
|
version_added: 2.2
|
||||||
|
required: false
|
||||||
|
default: null
|
||||||
bcc:
|
bcc:
|
||||||
description:
|
description:
|
||||||
- a list of email addresses to bcc
|
- a list of email addresses to bcc
|
||||||
version_added: 2.1
|
version_added: 2.2
|
||||||
|
required: false
|
||||||
|
default: null
|
||||||
attachments:
|
attachments:
|
||||||
description:
|
description:
|
||||||
- a list of relative or explicit paths of files you want to attach (7MB limit as per SendGrid docs)
|
- a list of relative or explicit paths of files you want to attach (7MB limit as per SendGrid docs)
|
||||||
version_added: 2.1
|
version_added: 2.2
|
||||||
|
required: false
|
||||||
|
default: null
|
||||||
from_name:
|
from_name:
|
||||||
description:
|
description:
|
||||||
- the name you want to appear in the from field, i.e 'John Doe'
|
- the name you want to appear in the from field, i.e 'John Doe'
|
||||||
version_added: 2.1
|
version_added: 2.2
|
||||||
|
required: false
|
||||||
|
default: null
|
||||||
html_body:
|
html_body:
|
||||||
description:
|
description:
|
||||||
- whether the body is html content that should be rendered
|
- whether the body is html content that should be rendered
|
||||||
version_added: 2.1
|
version_added: 2.2
|
||||||
choices: [True, False]
|
required: false
|
||||||
|
default: false
|
||||||
headers:
|
headers:
|
||||||
description:
|
description:
|
||||||
- a dict to pass on as headers
|
- a dict to pass on as headers
|
||||||
version_added: 2.1
|
version_added: 2.2
|
||||||
|
required: false
|
||||||
|
default: null
|
||||||
author: "Matt Makai (@makaimc)"
|
author: "Matt Makai (@makaimc)"
|
||||||
|
notes:
|
||||||
|
- since 2.2 username and password are not required if you supply an api_key.
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
Loading…
Reference in a new issue