core/homeassistant/components/mailgun/notify.py

97 lines
3.3 KiB
Python

"""Support for the Mailgun mail notifications."""
import logging
import voluptuous as vol
from homeassistant.components.mailgun import (
CONF_SANDBOX, DOMAIN as MAILGUN_DOMAIN)
from homeassistant.components.notify import (
PLATFORM_SCHEMA, BaseNotificationService, ATTR_TITLE, ATTR_TITLE_DEFAULT,
ATTR_DATA)
from homeassistant.const import (
CONF_API_KEY, CONF_DOMAIN, CONF_RECIPIENT, CONF_SENDER)
REQUIREMENTS = ['pymailgunner==1.4']
_LOGGER = logging.getLogger(__name__)
DEPENDENCIES = ['mailgun']
# Images to attach to notification
ATTR_IMAGES = 'images'
DEFAULT_SENDER = 'hass@{domain}'
DEFAULT_SANDBOX = False
# pylint: disable=no-value-for-parameter
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
vol.Required(CONF_RECIPIENT): vol.Email(),
vol.Optional(CONF_SENDER): vol.Email(),
})
def get_service(hass, config, discovery_info=None):
"""Get the Mailgun notification service."""
data = hass.data[MAILGUN_DOMAIN]
mailgun_service = MailgunNotificationService(
data.get(CONF_DOMAIN), data.get(CONF_SANDBOX),
data.get(CONF_API_KEY), config.get(CONF_SENDER),
config.get(CONF_RECIPIENT))
if mailgun_service.connection_is_valid():
return mailgun_service
return None
class MailgunNotificationService(BaseNotificationService):
"""Implement a notification service for the Mailgun mail service."""
def __init__(self, domain, sandbox, api_key, sender, recipient):
"""Initialize the service."""
self._client = None # Mailgun API client
self._domain = domain
self._sandbox = sandbox
self._api_key = api_key
self._sender = sender
self._recipient = recipient
def initialize_client(self):
"""Initialize the connection to Mailgun."""
from pymailgunner import Client
self._client = Client(self._api_key, self._domain, self._sandbox)
_LOGGER.debug("Mailgun domain: %s", self._client.domain)
self._domain = self._client.domain
if not self._sender:
self._sender = DEFAULT_SENDER.format(domain=self._domain)
def connection_is_valid(self):
"""Check whether the provided credentials are valid."""
from pymailgunner import (MailgunCredentialsError, MailgunDomainError)
try:
self.initialize_client()
except MailgunCredentialsError:
_LOGGER.exception("Invalid credentials")
return False
except MailgunDomainError as mailgun_error:
_LOGGER.exception(mailgun_error)
return False
return True
def send_message(self, message="", **kwargs):
"""Send a mail to the recipient."""
from pymailgunner import MailgunError
subject = kwargs.get(ATTR_TITLE, ATTR_TITLE_DEFAULT)
data = kwargs.get(ATTR_DATA)
files = data.get(ATTR_IMAGES) if data else None
try:
# Initialize the client in case it was not.
if self._client is None:
self.initialize_client()
resp = self._client.send_mail(
sender=self._sender, to=self._recipient, subject=subject,
text=message, files=files)
_LOGGER.debug("Message sent: %s", resp)
except MailgunError as mailgun_error:
_LOGGER.exception("Failed to send message: %s", mailgun_error)