Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.mailgun.notify.MailgunNotificationService Class Reference
Inheritance diagram for homeassistant.components.mailgun.notify.MailgunNotificationService:
[legend]
Collaboration diagram for homeassistant.components.mailgun.notify.MailgunNotificationService:
[legend]

Public Member Functions

def __init__ (self, domain, sandbox, api_key, sender, recipient)
 
def connection_is_valid (self)
 
def initialize_client (self)
 
def send_message (self, message="", **kwargs)
 

Private Attributes

 _api_key
 
 _client
 
 _domain
 
 _recipient
 
 _sandbox
 
 _sender
 

Detailed Description

Implement a notification service for the Mailgun mail service.

Definition at line 60 of file notify.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.mailgun.notify.MailgunNotificationService.__init__ (   self,
  domain,
  sandbox,
  api_key,
  sender,
  recipient 
)
Initialize the service.

Definition at line 63 of file notify.py.

Member Function Documentation

◆ connection_is_valid()

def homeassistant.components.mailgun.notify.MailgunNotificationService.connection_is_valid (   self)
Check whether the provided credentials are valid.

Definition at line 81 of file notify.py.

◆ initialize_client()

def homeassistant.components.mailgun.notify.MailgunNotificationService.initialize_client (   self)
Initialize the connection to Mailgun.

Definition at line 72 of file notify.py.

◆ send_message()

def homeassistant.components.mailgun.notify.MailgunNotificationService.send_message (   self,
  message = "",
**  kwargs 
)
Send a mail to the recipient.

Definition at line 94 of file notify.py.

Member Data Documentation

◆ _api_key

homeassistant.components.mailgun.notify.MailgunNotificationService._api_key
private

Definition at line 68 of file notify.py.

◆ _client

homeassistant.components.mailgun.notify.MailgunNotificationService._client
private

Definition at line 65 of file notify.py.

◆ _domain

homeassistant.components.mailgun.notify.MailgunNotificationService._domain
private

Definition at line 66 of file notify.py.

◆ _recipient

homeassistant.components.mailgun.notify.MailgunNotificationService._recipient
private

Definition at line 70 of file notify.py.

◆ _sandbox

homeassistant.components.mailgun.notify.MailgunNotificationService._sandbox
private

Definition at line 67 of file notify.py.

◆ _sender

homeassistant.components.mailgun.notify.MailgunNotificationService._sender
private

Definition at line 69 of file notify.py.


The documentation for this class was generated from the following file: