homeassistant.components.imap.config_flow Namespace Reference

Classes
class	IMAPConfigFlow
class	ImapOptionsFlow

Functions
dict[str, str]	validate_input (HomeAssistant hass, dict[str, Any] user_input)

Variables
	BOOLEAN_SELECTOR = BooleanSelector()
	CIPHER_SELECTOR
	CONFIG_SCHEMA
dictionary	CONFIG_SCHEMA_ADVANCED
	EVENT_MESSAGE_DATA_SELECTOR
	OPTIONS_SCHEMA
dictionary	OPTIONS_SCHEMA_ADVANCED
	TEMPLATE_SELECTOR = TemplateSelector(TemplateSelectorConfig())

Detailed Description

Config flow for imap integration.

Function Documentation

validate_input()

dict[str, str] homeassistant.components.imap.config_flow.validate_input	(	HomeAssistant	hass,
		dict[str, Any]	user_input
	)

Validate user input.

Definition at line 115 of file config_flow.py.

Variable Documentation

BOOLEAN_SELECTOR

homeassistant.components.imap.config_flow.BOOLEAN_SELECTOR = BooleanSelector()

Definition at line 57 of file config_flow.py.

CIPHER_SELECTOR

homeassistant.components.imap.config_flow.CIPHER_SELECTOR

Initial value:

=  SelectSelector(
    SelectSelectorConfig(
        options=list(SSLCipherList),
        mode=SelectSelectorMode.DROPDOWN,
        translation_key=CONF_SSL_CIPHER_LIST,
    )
)

Definition at line 58 of file config_flow.py.

CONFIG_SCHEMA

homeassistant.components.imap.config_flow.CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_USERNAME): str,
        vol.Required(CONF_PASSWORD): str,
        vol.Required(CONF_SERVER): str,
        vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
        vol.Optional(CONF_CHARSET, default="utf-8"): str,
        vol.Optional(CONF_FOLDER, default="INBOX"): str,
        vol.Optional(CONF_SEARCH, default="UnSeen UnDeleted"): str,
        # The default for new entries is to not include text and headers
        vol.Optional(CONF_EVENT_MESSAGE_DATA, default=[]): EVENT_MESSAGE_DATA_SELECTOR,
    }
)

Definition at line 74 of file config_flow.py.

CONFIG_SCHEMA_ADVANCED

dictionary homeassistant.components.imap.config_flow.CONFIG_SCHEMA_ADVANCED

Initial value:

=  {
    vol.Optional(
        CONF_SSL_CIPHER_LIST, default=SSLCipherList.PYTHON_DEFAULT
    ): CIPHER_SELECTOR,
    vol.Optional(CONF_VERIFY_SSL, default=True): BOOLEAN_SELECTOR,
}

Definition at line 87 of file config_flow.py.

EVENT_MESSAGE_DATA_SELECTOR

homeassistant.components.imap.config_flow.EVENT_MESSAGE_DATA_SELECTOR

Initial value:

=  SelectSelector(
    SelectSelectorConfig(
        options=MESSAGE_DATA_OPTIONS,
        translation_key=CONF_EVENT_MESSAGE_DATA,
        multiple=True,
    )
)

Definition at line 66 of file config_flow.py.

OPTIONS_SCHEMA

homeassistant.components.imap.config_flow.OPTIONS_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Optional(CONF_FOLDER, default="INBOX"): str,
        vol.Optional(CONF_SEARCH, default="UnSeen UnDeleted"): str,
        # The default for older entries is to include text and headers
        vol.Optional(
            CONF_EVENT_MESSAGE_DATA, default=MESSAGE_DATA_OPTIONS
        ): EVENT_MESSAGE_DATA_SELECTOR,
    }
)

Definition at line 94 of file config_flow.py.

OPTIONS_SCHEMA_ADVANCED

dictionary homeassistant.components.imap.config_flow.OPTIONS_SCHEMA_ADVANCED

Initial value:

=  {
    vol.Optional(CONF_CUSTOM_EVENT_DATA_TEMPLATE): TEMPLATE_SELECTOR,
    vol.Optional(CONF_MAX_MESSAGE_SIZE, default=DEFAULT_MAX_MESSAGE_SIZE): vol.All(
        cv.positive_int,
        vol.Range(min=DEFAULT_MAX_MESSAGE_SIZE, max=MAX_MESSAGE_SIZE_LIMIT),
    ),
    vol.Optional(CONF_ENABLE_PUSH, default=True): BOOLEAN_SELECTOR,
}

Definition at line 105 of file config_flow.py.

TEMPLATE_SELECTOR

homeassistant.components.imap.config_flow.TEMPLATE_SELECTOR = TemplateSelector(TemplateSelectorConfig())

Definition at line 65 of file config_flow.py.