homeassistant.components.mailgun Namespace Reference

Namespaces
	config_flow
	const
	notify

Functions
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	async_setup_entry (HomeAssistant hass, ConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry entry)
None	handle_webhook (HomeAssistant hass, str webhook_id, web.Request request)
def	verify_webhook (hass, token=None, timestamp=None, signature=None)

Variables
	_LOGGER = logging.getLogger(__name__)
	async_remove_entry = config_entry_flow.webhook_async_remove_entry
string	CONF_SANDBOX = "sandbox"
	CONFIG_SCHEMA
bool	DEFAULT_SANDBOX = False
string	MESSAGE_RECEIVED = f"{DOMAIN}_message_received"

Detailed Description

Support for Mailgun.

Function Documentation

async_setup()

bool homeassistant.components.mailgun.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up the Mailgun component.

Definition at line 43 of file __init__.py.

async_setup_entry()

bool homeassistant.components.mailgun.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Configure based on config entry.

Definition at line 95 of file __init__.py.

async_unload_entry()

bool homeassistant.components.mailgun.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Unload a config entry.

Definition at line 103 of file __init__.py.

handle_webhook()

None homeassistant.components.mailgun.handle_webhook	(	HomeAssistant	hass,
		str	webhook_id,
		web.Request	request
	)

Handle incoming webhook with Mailgun inbound messages.

Definition at line 52 of file __init__.py.

verify_webhook()

def homeassistant.components.mailgun.verify_webhook	(		hass,
			token = None,
			timestamp = None,
			signature = None
	)

Verify webhook was signed by Mailgun.

Definition at line 77 of file __init__.py.

Variable Documentation

_LOGGER

homeassistant.components.mailgun._LOGGER = logging.getLogger(__name__)

private

Definition at line 21 of file __init__.py.

async_remove_entry

homeassistant.components.mailgun.async_remove_entry = config_entry_flow.webhook_async_remove_entry

Definition at line 109 of file __init__.py.

CONF_SANDBOX

string homeassistant.components.mailgun.CONF_SANDBOX = "sandbox"

Definition at line 23 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.mailgun.CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Optional(DOMAIN): vol.Schema(
            {
                vol.Required(CONF_API_KEY): cv.string,
                vol.Required(CONF_DOMAIN): cv.string,
                vol.Optional(CONF_SANDBOX, default=DEFAULT_SANDBOX): cv.boolean,
            }
        )
    },
    extra=vol.ALLOW_EXTRA,
)

Definition at line 29 of file __init__.py.

DEFAULT_SANDBOX

bool homeassistant.components.mailgun.DEFAULT_SANDBOX = False

Definition at line 25 of file __init__.py.

MESSAGE_RECEIVED

string homeassistant.components.mailgun.MESSAGE_RECEIVED = f"{DOMAIN}_message_received"

Definition at line 27 of file __init__.py.