mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 15:26:59 +00:00
Update Mailgun component configuration (#6902)
* Update Mailgun component configuration * 🚑 Fixes * ✏️ Description change
This commit is contained in:
parent
9c746c1b9d
commit
d8d326c316
@ -27,8 +27,18 @@ mailgun:
|
|||||||
api_key: XXXXXXXXXXXXX
|
api_key: XXXXXXXXXXXXX
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
domain:
|
||||||
- **domain** (*Required*): This is the domain name to be used when sending out mail. Defaults to the first custom domain you have set up.
|
description: This is the domain name to be used when sending out mail. Needs to be the first custom domain you have set up.
|
||||||
- **api_key** (*Required*): This is the API token that has been generated in your Mailgun account.
|
required: true
|
||||||
- **sandbox** (*Deprecated*): Whether to use the sandboxed domain for outgoing mail. Since the `domain` item is required, it should be set to the sandbox domain name, so this isn't needed. Defaults to `False`.
|
type: string
|
||||||
|
api_key:
|
||||||
|
description: This is the API token that has been generated in your Mailgun account.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
sandbox:
|
||||||
|
description: "(**Deprecated**) Whether to use the sandboxed domain for outgoing mail. Since the `domain` item is required, it should be set to the sandbox domain name, so this isn't needed."
|
||||||
|
required: false
|
||||||
|
default: false
|
||||||
|
type: boolean
|
||||||
|
{% endconfiguration %}
|
||||||
|
@ -30,13 +30,30 @@ notify:
|
|||||||
recipient: me@example.com
|
recipient: me@example.com
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
domain:
|
||||||
- **domain** (*Required*): This is the domain name to be used when sending out mail.
|
description: This is the domain name to be used when sending out mail.
|
||||||
- **sandbox** (*Deprecated*): If a sandboxed domain is used, specify it in `domain`. Defaults to `False`.
|
required: true
|
||||||
- **api_key** (*Required*): This is the API Key that has been generated in your Mailgun account.
|
type: string
|
||||||
- **recipient** (*Required*): The email address of the recipient.
|
sandbox:
|
||||||
- **sender** (*Optional*): The sender's email address. Defaults to `hass@DOMAIN`, where `DOMAIN` is the outgoing mail domain, as defined by the `domain` configuration entry.
|
description: "(**Deprecated**) If a sandboxed domain is used, specify it in `domain`."
|
||||||
|
required: false
|
||||||
|
default: false
|
||||||
|
type: boolean
|
||||||
|
api_key:
|
||||||
|
description: This is the API Key that has been generated in your Mailgun account.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
recipient:
|
||||||
|
description: The email address of the recipient.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
sender:
|
||||||
|
description: The sender's email address.
|
||||||
|
required: false
|
||||||
|
default: "`hass@DOMAIN`, where `DOMAIN` is the outgoing mail domain, as defined by the `domain` configuration entry."
|
||||||
|
type: string
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
## {% linkable_title Example automation %}
|
## {% linkable_title Example automation %}
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user