kavita_client.api.settings.get_api_settings_is_email_setup

Module Contents

Functions

asyncio	Is the minimum information setup for Email to work
asyncio_detailed	Is the minimum information setup for Email to work
sync	Is the minimum information setup for Email to work
sync_detailed	Is the minimum information setup for Email to work

API

async kavita_client.api.settings.get_api_settings_is_email_setup.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, for_device: bool | kavita_client.types.Unset = False) → bool | None

Is the minimum information setup for Email to work

Args:

for_device (bool | Unset): Default: False.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

bool

async kavita_client.api.settings.get_api_settings_is_email_setup.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, for_device: bool | kavita_client.types.Unset = False) → kavita_client.types.Response[bool]

Is the minimum information setup for Email to work

Args:

for_device (bool | Unset): Default: False.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[bool]

kavita_client.api.settings.get_api_settings_is_email_setup.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, for_device: bool | kavita_client.types.Unset = False) → bool | None

Is the minimum information setup for Email to work

Args:

for_device (bool | Unset): Default: False.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

bool

kavita_client.api.settings.get_api_settings_is_email_setup.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, for_device: bool | kavita_client.types.Unset = False) → kavita_client.types.Response[bool]

Is the minimum information setup for Email to work

Args:

for_device (bool | Unset): Default: False.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[bool]