From ebe8eb7852b9bcc86cb2c02f6da43017da14c1ca Mon Sep 17 00:00:00 2001 From: plyblu Date: Sun, 2 Sep 2018 02:46:45 -0500 Subject: [PATCH] Update mailgun.markdown (#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. --- source/_components/mailgun.markdown | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/_components/mailgun.markdown b/source/_components/mailgun.markdown index 2f13d2c0625..e1ecaefc72a 100644 --- a/source/_components/mailgun.markdown +++ b/source/_components/mailgun.markdown @@ -12,7 +12,7 @@ ha_category: Notifications 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:///api/mailgun?api_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:///api/mailgun?api_password=` 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 mailgun: domain: mg.example.com - api_key: token-XXXXXXXXX + api_key: XXXXXXXXXXXXX ``` 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. - **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`.