plyblu ebe8eb7852 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.
2018-09-02 09:46:45 +02:00

1.2 KiB

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release
layout title description date sidebar comments sharing footer logo ha_category ha_release
page Mailgun Instructions on how to add Mailgun mail notifications to Home Assistant. 2017-02-06 16:52 true false true true mailgun.png Notifications 0.38

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.

{% linkable_title Sample configuration %}

# Example configuration.yaml entry
mailgun:
  domain: mg.example.com
  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 (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.