home-assistant.io/source/_components/notify.mailgun.markdown
Stuart McCroden 72631830da Standardize example configuration blocks (#6953)
* Standardized values in the example configuration

Removed what appear to be an actual API key from the example configuration.yaml block. And, replaced with values as described in the [developer docs](https://developers.home-assistant.io/docs/en/documentation_standards.html#component-and-platform-pages)

* Standardize example configuration-ecobee

* Standardize example configuration-coinbase

* Standardize example configuration-google assistant

* Standardize example configuration-cloudflare

* Standardize example configuration-cloudflare

* Standardize example configuration-habitica

* Standardize example configuration-ifttt

* Standardize example configuration-openalpr

* Standardize example configuration-multiple

* Standardize example configuration-instapush

* Standardize example configuration-llamalab

* Standardize example configuration-notify

* Standardize example configuration-mailgun

* Standardize example configuration-MULTIPLE

* Standardize example configuration-rtm

* Standardize example configuration-spotcrime

* Standardize example configuration-trafikverket

* Standardize example configuration-uk transport

* Standardize example configuration-wunderground

* Standardize example configuration-wsdot

* Standardize example configuration-telegram

* Standardize example configuration-tts

* Standardize example configuration-tts, vultr

* Replace email entry

* Replace IP address

* Place email address
2018-10-19 22:52:25 +02:00

1.9 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 Notify 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 Mailgun notification service allows you to send emails via Mailgun's REST API. It requires the Mailgun component to be set up.

{% linkable_title Sample configuration %}

# Example configuration.yaml entry
mailgun:
  domain: EXAMPLE.COM
  api_key: YOUR_API_KEY

notify:
  - name: mailgun
    platform: mailgun
    recipient: CHANGE@EXAMPLE.COM

{% configuration %} domain: description: This is the domain name to be used when sending out mail. required: true type: string sandbox: description: "(Deprecated) If a sandboxed domain is used, specify it in domain." required: false default: false type: boolean api_key: description: This is the API Key that has been generated in your Mailgun account. required: true type: string recipient: description: The email address of the recipient. required: true type: string sender: description: The sender's email address. required: false default: "hass@DOMAIN, where DOMAIN is the outgoing mail domain, as defined by the domain configuration entry." type: string {% endconfiguration %}

{% linkable_title Example automation %}

The following automation reacts to an event by sending out an email with two attachments.

# Example automation using Mailgun notifications
automation:
  trigger:
    platform: event
    event_type: SPECIAL_EVENT
  action:
    service: notify.mailgun
    data:
      title: "Something special has happened"
      message: "This a test message from Home Assistant"
      data:
        images:
          - /home/pi/pic_test1.png
          - /home/pi/pic_test2.png