jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/notify.mailgun/index.html
Travis CI db3021af91 Site updated at 2017-12-17 16:27:07 UTC
2017-12-17 16:27:07 +00:00

373 lines
16 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Mailgun Notify - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to add Mailgun mail notifications to Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/notify.mailgun/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Mailgun Notify">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/notify.mailgun/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to add Mailgun mail notifications to Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="Mailgun Notify">
<meta name="twitter:description" content="Instructions how to add Mailgun mail notifications to Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection, print" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header class='site-header'>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href="/getting-started/">Getting started</a></li>
<li><a href="/components/">Components</a></li>
<li><a href="/docs/">Docs</a></li>
<li><a href="/cookbook/">Examples</a></li>
<li><a href="/developers/">Developers</a></li>
<li><a href="/blog/">Blog</a></li>
<li><a href="/help/">Need help?</a></li>
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
</ul>
</nav>
<div class='search-container' style='display: none'>
<div class='search'>
<i class="icon-search"></i>
<input id='search' placeholder='Search the docs…'>
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
</div>
</div>
</div>
</div>
</div>
</header>
<div class="grid-wrapper">
<div class="grid grid-center">
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
<article class="page">
<header>
<h1 class="title indent">
Mailgun Notify
</h1>
</header>
<hr class="divider">
<p>The Mailgun notification service allows you to send emails via Mailgun’s REST API. It requires the <a href="/components/mailgun/">Mailgun component</a> to be set up.</p>
<h2><a class="title-link" name="sample-configuration" href="#sample-configuration"></a> Sample configuration</h2>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">mailgun</span><span class="pi">:</span>
<span class="s">domain</span><span class="pi">:</span> <span class="s">mg.example.com</span>
<span class="s">api_key</span><span class="pi">:</span> <span class="s">token-XXXXXXXXX</span>
<span class="s">sandbox</span><span class="pi">:</span> <span class="s">False</span>
<span class="s">notify</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">name</span><span class="pi">:</span> <span class="s">mailgun</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">mailgun</span>
<span class="s">recipient</span><span class="pi">:</span> <span class="s">me@example.com</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>domain</strong> (<em>Optional</em>): This is the domain name to be used when sending out mail. Defaults to the first custom domain you have set up.</li>
<li><strong>sandbox</strong> (<em>Optional</em>): Whether to use the sandboxed domain for outgoing mail. The <code class="highlighter-rouge">domain</code> item takes precedence over this. Defaults to <code class="highlighter-rouge">False</code>.</li>
<li><strong>token</strong> (<em>Required</em>): This is the API token that has been generated in your Mailgun account.</li>
<li><strong>recipient</strong> (<em>Required</em>): The email address of the recipient.</li>
<li><strong>sender</strong> (<em>Optional</em>): The sender’s email address. Defaults to <code class="highlighter-rouge">hass@DOMAIN</code>, where <code class="highlighter-rouge">DOMAIN</code> is outgoint mail domain, as defined by the <code class="highlighter-rouge">domain</code> and <code class="highlighter-rouge">sanbox</code> configuration entries.</li>
</ul>
<h2><a class="title-link" name="example-automation" href="#example-automation"></a> Example automation</h2>
<p>The following automation reacts to an event by sending out an email with two attachments.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example automation using Mailgun notifications</span>
<span class="s">automation</span><span class="pi">:</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">SPECIAL_EVENT</span>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">notify.mailgun</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">title</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Something</span><span class="nv"> </span><span class="s">special</span><span class="nv"> </span><span class="s">has</span><span class="nv"> </span><span class="s">happened"</span>
<span class="s">message</span><span class="pi">:</span> <span class="s2">"</span><span class="s">This</span><span class="nv"> </span><span class="s">a</span><span class="nv"> </span><span class="s">test</span><span class="nv"> </span><span class="s">message</span><span class="nv"> </span><span class="s">from</span><span class="nv"> </span><span class="s">Home</span><span class="nv"> </span><span class="s">Assistant"</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">images</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">/home/pi/pic_test1.png</span>
<span class="pi">-</span> <span class="s">/home/pi/pic_test2.png</span>
</code></pre>
</div>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/notify.mailgun.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/mailgun.png' />
</div>
<div class='section'>
Introduced in release: 0.38
</div>
<div class='section'>
Source:
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/notify/mailgun.py'>notify/mailgun.py</a>
</div>
<div class='section'>
This is a platform for
<a href='/components/notify/'>the Notifications component</a>.
</div>
<div class='section'>
<h1 class='title delta'>Related components</h1>
<ul class='divided'>
<li><a href='/components/mailgun/'>
Mailgun
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category Notifications</h1>
<ul class='divided'>
<li>
<a href='/components/notify.apns/'>APNS</a>
</li>
<li>
<a href='/components/notify.aws_lambda/'>AWS Lambda</a>
</li>
<li>
<a href='/components/notify.aws_sns/'>AWS SNS</a>
</li>
<li>
<a href='/components/notify.aws_sqs/'>AWS SQS</a>
</li>
<li>
<a href='/components/notify.ciscospark/'>Cisco Spark</a>
</li>
<li>
<a href='/components/notify.clicksend/'>ClickSend SMS</a>
</li>
<li>
<a href='/components/notify.clicksend_tts/'>ClickSend text-to-speech</a>
</li>
<li>
<a href='/components/notify.clickatell/'>Clickatell SMS</a>
</li>
<li>
<a href='/components/notify.command_line/'>Command line Notify</a>
</li>
<li>
<a href='/components/notify.discord/'>Discord</a>
</li>
<li>
<a href='/components/notify.ecobee/'>Ecobee Notify</a>
</li>
<li>
<a href='/components/notify.facebook/'>Facebook Messenger</a>
</li>
<li>
<a href='/components/notify.file/'>File</a>
</li>
<li>
<a href='/components/notify.free_mobile/'>Free Mobile</a>
</li>
<li>
<a href='/components/notify.gntp/'>GNTP (Growl)</a>
</li>
<li>
<a href='/components/notify.hipchat/'>HipChat</a>
</li>
<li>
<a href='/components/notify.instapush/'>Instapush</a>
</li>
<li>
<a href='/components/notify.xmpp/'>Jabber (XMPP)</a>
</li>
<li>
<a href='/components/notify.joaoapps_join/'>Join Notify</a>
</li>
<li>
<a href='/components/notify.knx/'>KNX Notify</a>
</li>
<li>
<a href='/components/notify.kodi/'>Kodi</a>
</li>
<li>
<a href='/components/notify.webostv/'>LG WebOS TV notifications</a>
</li>
<li>
<a href='/components/notify.lametric/'>LaMetric Notify</a>
</li>
<li>
<a href='/components/notify.lannouncer/'>Lannouncer</a>
</li>
<li>
<a href='/components/notify.llamalab_automate/'>LlamaLab Automate</a>
</li>
<li>
<a href='/components/notify.mqtt/'>MQTT Notifications</a>
</li>
<li>
<a href='/components/mailgun/'>Mailgun</a>
</li>
<li>
Mailgun Notify
</li>
<li>
<a href='/components/notify.matrix/'>Matrix</a>
</li>
<li>
<a href='/components/notify.message_bird/'>MessageBird</a>
</li>
<li>
<a href='/components/notify.mysensors/'>MySensors Notify</a>
</li>
<li>
<a href='/components/notify.mycroft/'>Mycroft AI</a>
</li>
<li>
<a href='/components/notify.nfandroidtv/'>Notifications for Android TV / FireTV</a>
</li>
<li>
<a href='/components/notify.group/'>Notify Group</a>
</li>
<li>
<a href='/components/notify.nma/'>Notify My Android</a>
</li>
<li>
<a href='/components/notify.prowl/'>Prowl</a>
</li>
<li>
<a href='/components/notify.html5/'>Push Notifications</a>
</li>
<li>
<a href='/components/notify.pushbullet/'>Pushbullet</a>
</li>
<li>
<a href='/components/notify.pushetta/'>Pushetta</a>
</li>
<li>
<a href='/components/notify.pushover/'>Pushover</a>
</li>
<li>
<a href='/components/notify.pushsafer/'>Pushsafer</a>
</li>
<li>
<a href='/components/notify.rest/'>REST</a>
</li>
<li>
<a href='/components/notify.rocketchat/'>Rocket.Chat</a>
</li>
<li>
<a href='/components/notify.smtp/'>SMTP</a>
</li>
<li>
<a href='/components/notify.sendgrid/'>SendGrid</a>
</li>
<li>
<a href='/components/notify.simplepush/'>Simplepush</a>
</li>
<li>
<a href='/components/notify.slack/'>Slack</a>
</li>
<li>
<a href='/components/notify.syslog/'>Syslog</a>
</li>
<li>
<a href='/components/notify.telegram/'>Telegram</a>
</li>
<li>
<a href='/components/telegram_bot.broadcast/'>Telegram broadcast</a>
</li>
<li>
<a href='/components/telegram_bot.polling/'>Telegram polling</a>
</li>
<li>
<a href='/components/telegram_bot.webhooks/'>Telegram webhooks</a>
</li>
<li>
<a href='/components/notify.telstra/'>Telstra</a>
</li>
<li>
<a href='/components/notify.twilio_call/'>Twilio Call</a>
</li>
<li>
<a href='/components/notify.twilio_sms/'>Twilio SMS</a>
</li>
<li>
<a href='/components/notify.twitter/'>Twitter</a>
</li>
<li>
<a href='/components/notify.yessssms/'>Yesss SMS</a>
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
</div>
</div>
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
<script type="text/javascript">
docsearch({
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
indexName: 'home-assistant',
inputSelector: '#search',
debug: false // Set debug to true if you want to inspect the dropdown
});
document.querySelector('.search .close').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'none';
});
document.querySelector('.show-search').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'block';
document.getElementById('toggle').checked = false;
document.querySelector('.search-container input').focus();
});
</script>
</body>
</html>
Reference in a new issue View git blame Copy permalink