jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-13 20:36:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update mailgun.markdown (#6143)

Browse Source 
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.
This commit is contained in:
plyblu 2018-09-02 02:46:45 -05:00 committed by Fabian Affolter
parent 8a04b73d40
commit ebe8eb7852
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
source/_components/mailgun.markdown
View File

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