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-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update notify.mailgun.markdown (#6142)

Browse Source 
* Update notify.mailgun.markdown

Fix inconsistency where "domain" is required in the Mailgun Component https://www.home-assistant.io/components/mailgun/ 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.  Also removed all references to the obsolete word "token" to avoid confusion.  Also used a different name for the notify service to differentiate it from the mailgun component.  Note: There are also updates to the aforementioned Mailgun Component doc.

* There is no need for the postfix
This commit is contained in:
plyblu 2018-09-02 12:30:25 -05:00 committed by Fabian Affolter
parent b87d7e8a41
commit c1f7bce304
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
source/_components/notify.mailgun.markdown
View File

@ -22,8 +22,7 @@ The Mailgun notification service allows you to send emails via Mailgun's REST AP
# Example configuration.yaml entry
mailgun:
domain: mg.example.com
api_key: token-XXXXXXXXX
sandbox: False
api_key: XXXXXXXXXXXXXX
notify:
- name: mailgun
@ -33,11 +32,11 @@ notify:
Configuration variables:
- **domain** (*Optional*): This is the domain name to be used when sending out mail. Defaults to the first custom domain you have set up.
- **sandbox** (*Optional*): Whether to use the sandboxed domain for outgoing mail. The `domain` item takes precedence over this. Defaults to `False`.
- **token** (*Required*): This is the API token that has been generated in your Mailgun account.
- **domain** (*Required*): 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`.
- **api_key** (*Required*): This is the API Key that has been generated in your Mailgun account.
- **recipient** (*Required*): The email address of the recipient.
- **sender** (*Optional*): The sender's email address. Defaults to `hass@DOMAIN`, where `DOMAIN` is outgoint mail domain, as defined by the `domain` and `sanbox` configuration entries.
- **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.
## {% linkable_title Example automation %}