Namespaces
	config_flow

	const

	coordinator

	diagnostics

	errors

	sensor

Functions
IMAP4_SSL	async_get_imap_client (HomeAssistant hass, str entry_id)

bool	async_setup (HomeAssistant hass, ConfigType config)

bool	async_setup_entry (HomeAssistant hass, ImapConfigEntry entry)

bool	async_unload_entry (HomeAssistant hass, ImapConfigEntry entry)

None	raise_on_error (Response response, str translation_key)

Variables
	_LOGGER = logging.getLogger(__name__)

	_SERVICE_UID_SCHEMA

string	CONF_ENTRY = "entry"

string	CONF_SEEN = "seen"

string	CONF_TARGET_FOLDER = "target_folder"

string	CONF_UID = "uid"

	CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN)

	ImapConfigEntry

	SERVICE_DELETE_SCHEMA = _SERVICE_UID_SCHEMA

	SERVICE_FETCH_TEXT_SCHEMA = _SERVICE_UID_SCHEMA

	SERVICE_MOVE_SCHEMA

	SERVICE_SEEN_SCHEMA = _SERVICE_UID_SCHEMA

Detailed Description

The imap integration.

Function Documentation

◆ async_get_imap_client()

IMAP4_SSL homeassistant.components.imap.async_get_imap_client	(	HomeAssistant	hass,
		str	entry_id
	)

Get IMAP client and connect.

Definition at line 71 of file __init__.py.

◆ async_setup()

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

Set up imap services.

Definition at line 111 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.imap.async_setup_entry	(	HomeAssistant	hass,
		ImapConfigEntry	entry
	)

Set up imap from a config entry.

Definition at line 239 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.imap.async_unload_entry	(	HomeAssistant	hass,
		ImapConfigEntry	entry
	)

Unload a config entry.

Definition at line 273 of file __init__.py.

◆ raise_on_error()

None homeassistant.components.imap.raise_on_error	(	Response	response,
		str	translation_key
	)

Get error message from response.

Definition at line 100 of file __init__.py.

Variable Documentation

◆ _LOGGER

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

private

Definition at line 46 of file __init__.py.

◆ _SERVICE_UID_SCHEMA

homeassistant.components.imap._SERVICE_UID_SCHEMA

private

Initial value:

 =  vol.Schema(
     {
         vol.Required(CONF_ENTRY): cv.string,
         vol.Required(CONF_UID): cv.string,
     }
 )

Definition at line 51 of file __init__.py.

◆ CONF_ENTRY

string homeassistant.components.imap.CONF_ENTRY = "entry"

Definition at line 41 of file __init__.py.

◆ CONF_SEEN

string homeassistant.components.imap.CONF_SEEN = "seen"

Definition at line 42 of file __init__.py.

◆ CONF_TARGET_FOLDER

string homeassistant.components.imap.CONF_TARGET_FOLDER = "target_folder"

Definition at line 44 of file __init__.py.

◆ CONF_UID

string homeassistant.components.imap.CONF_UID = "uid"

Definition at line 43 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.imap.CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN)

Definition at line 49 of file __init__.py.

◆ ImapConfigEntry

homeassistant.components.imap.ImapConfigEntry

Definition at line 68 of file __init__.py.

◆ SERVICE_DELETE_SCHEMA

homeassistant.components.imap.SERVICE_DELETE_SCHEMA = _SERVICE_UID_SCHEMA

Definition at line 65 of file __init__.py.

◆ SERVICE_FETCH_TEXT_SCHEMA

homeassistant.components.imap.SERVICE_FETCH_TEXT_SCHEMA = _SERVICE_UID_SCHEMA

Definition at line 66 of file __init__.py.

◆ SERVICE_MOVE_SCHEMA

homeassistant.components.imap.SERVICE_MOVE_SCHEMA