jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-23 13:17:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Correct imap services setup (#114760)

Browse Source 
* Correct imap services setup

* Add config schema
This commit is contained in:
Jan Bouwhuis 2024-04-03 18:40:59 +02:00 committed by GitHub
parent 51a3e79048
commit d66145358a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 37 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
homeassistant/components/imap/__init__.py
View File

@ -19,6 +19,7 @@ from homeassistant.exceptions import (
ServiceValidationError, ServiceValidationError,
) )
import homeassistant.helpers.config_validation as cv import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.typing import ConfigType
from .const import CONF_ENABLE_PUSH, DOMAIN from .const import CONF_ENABLE_PUSH, DOMAIN
from .coordinator import ( from .coordinator import (
@ -37,6 +38,9 @@ CONF_TARGET_FOLDER = "target_folder"
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN)
_SERVICE_UID_SCHEMA = vol.Schema( _SERVICE_UID_SCHEMA = vol.Schema(
{ {
vol.Required(CONF_ENTRY): cv.string, vol.Required(CONF_ENTRY): cv.string,
@ -95,30 +99,8 @@ def raise_on_error(response: Response, translation_key: str) -> None:
) )
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool: async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
"""Set up imap from a config entry.""" """Set up imap services."""
try:
imap_client: IMAP4_SSL = await connect_to_server(dict(entry.data))
except InvalidAuth as err:
raise ConfigEntryAuthFailed from err
except InvalidFolder as err:
raise ConfigEntryError("Selected mailbox folder is invalid.") from err
except (TimeoutError, AioImapException) as err:
raise ConfigEntryNotReady from err
coordinator_class: type[
ImapPushDataUpdateCoordinator | ImapPollingDataUpdateCoordinator
]
enable_push: bool = entry.data.get(CONF_ENABLE_PUSH, True)
if enable_push and imap_client.has_capability("IDLE"):
coordinator_class = ImapPushDataUpdateCoordinator
else:
coordinator_class = ImapPollingDataUpdateCoordinator
coordinator: ImapPushDataUpdateCoordinator | ImapPollingDataUpdateCoordinator = (
coordinator_class(hass, imap_client, entry)
)
await coordinator.async_config_entry_first_refresh()
async def async_seen(call: ServiceCall) -> None: async def async_seen(call: ServiceCall) -> None:
"""Process mark as seen service call.""" """Process mark as seen service call."""
@ -141,8 +123,7 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
raise_on_error(response, "seen_failed") raise_on_error(response, "seen_failed")
await client.close() await client.close()
if not hass.services.has_service(DOMAIN, "seen"): hass.services.async_register(DOMAIN, "seen", async_seen, SERVICE_SEEN_SCHEMA)
hass.services.async_register(DOMAIN, "seen", async_seen, SERVICE_SEEN_SCHEMA)
async def async_move(call: ServiceCall) -> None: async def async_move(call: ServiceCall) -> None:
"""Process move email service call.""" """Process move email service call."""
@ -178,8 +159,7 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
) from exc ) from exc
await client.close() await client.close()
if not hass.services.has_service(DOMAIN, "move"): hass.services.async_register(DOMAIN, "move", async_move, SERVICE_MOVE_SCHEMA)
hass.services.async_register(DOMAIN, "move", async_move, SERVICE_MOVE_SCHEMA)
async def async_delete(call: ServiceCall) -> None: async def async_delete(call: ServiceCall) -> None:
"""Process deleting email service call.""" """Process deleting email service call."""
@ -206,10 +186,35 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
) from exc ) from exc
await client.close() await client.close()
if not hass.services.has_service(DOMAIN, "delete"): hass.services.async_register(DOMAIN, "delete", async_delete, SERVICE_DELETE_SCHEMA)
hass.services.async_register(
DOMAIN, "delete", async_delete, SERVICE_DELETE_SCHEMA return True
)
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
"""Set up imap from a config entry."""
try:
imap_client: IMAP4_SSL = await connect_to_server(dict(entry.data))
except InvalidAuth as err:
raise ConfigEntryAuthFailed from err
except InvalidFolder as err:
raise ConfigEntryError("Selected mailbox folder is invalid.") from err
except (TimeoutError, AioImapException) as err:
raise ConfigEntryNotReady from err
coordinator_class: type[
ImapPushDataUpdateCoordinator | ImapPollingDataUpdateCoordinator
]
enable_push: bool = entry.data.get(CONF_ENABLE_PUSH, True)
if enable_push and imap_client.has_capability("IDLE"):
coordinator_class = ImapPushDataUpdateCoordinator
else:
coordinator_class = ImapPollingDataUpdateCoordinator
coordinator: ImapPushDataUpdateCoordinator | ImapPollingDataUpdateCoordinator = (
coordinator_class(hass, imap_client, entry)
)
await coordinator.async_config_entry_first_refresh()
hass.data.setdefault(DOMAIN, {})[entry.entry_id] = coordinator hass.data.setdefault(DOMAIN, {})[entry.entry_id] = coordinator
@ -229,8 +234,4 @@ async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
ImapPushDataUpdateCoordinator | ImapPollingDataUpdateCoordinator ImapPushDataUpdateCoordinator | ImapPollingDataUpdateCoordinator
) = hass.data[DOMAIN].pop(entry.entry_id) ) = hass.data[DOMAIN].pop(entry.entry_id)
await coordinator.shutdown() await coordinator.shutdown()
if not hass.data[DOMAIN]:
hass.services.async_remove(DOMAIN, "seen")
hass.services.async_remove(DOMAIN, "move")
hass.services.async_remove(DOMAIN, "delete")
return unload_ok return unload_ok