Skip to content

Commit ebe8eb7

Browse files
plyblufabaff
authored andcommitted
Update mailgun.markdown (home-assistant#6143)
Fix inconsistency where "domain" is required but "sandbox" can also be used to specify the domain. It appears that the package https://github.com/pschmitt/pymailgunner in def guess_domain allows multiple domains and "sandbox" can be used to choose a sandbox domain over a normal domain. As far as I can tell, this feature isn't used by the Mailgun component. There are also updates to the Mailgun Notify doc.
1 parent 8a04b73 commit ebe8eb7

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

source/_components/mailgun.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ha_category: Notifications
1212
ha_release: 0.38
1313
---
1414

15-
The component supports push messages and generates events based on inbound data. To use, add a Route set to Store and Notify with a URL of the following form: `https://<home-assistant-domain>/api/mailgun?api_password=<password>`
15+
The component supports push messages and generates events based on inbound data. To generate inbound events, add a Route set to Store and Notify with a URL of the following form: `https://<home-assistant-domain>/api/mailgun?api_password=<password>`
1616

1717
To send messages, use the [Mailgun notify platform][notify].
1818

@@ -24,11 +24,11 @@ To send messages, use the [Mailgun notify platform][notify].
2424
# Example configuration.yaml entry
2525
mailgun:
2626
domain: mg.example.com
27-
api_key: token-XXXXXXXXX
27+
api_key: XXXXXXXXXXXXX
2828
```
2929
3030
Configuration variables:
3131
3232
- **domain** (*Required*): This is the domain name to be used when sending out mail. Defaults to the first custom domain you have set up.
3333
- **api_key** (*Required*): This is the API token that has been generated in your Mailgun account.
34-
- **sandbox** (*Optional*): Whether to use the sandboxed domain for outgoing mail. The `domain` item takes precedence over this. Defaults to `False`.
34+
- **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`.

0 commit comments

Comments
 (0)