kavita_client.api.settings.post_api_settings_test_email_url

Module Contents

Functions

asyncio	Sends a test email to see if email settings are hooked up correctly
asyncio_detailed	Sends a test email to see if email settings are hooked up correctly
sync	Sends a test email to see if email settings are hooked up correctly
sync_detailed	Sends a test email to see if email settings are hooked up correctly

API

async kavita_client.api.settings.post_api_settings_test_email_url.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → kavita_client.models.email_test_result_dto.EmailTestResultDto | None

Sends a test email to see if email settings are hooked up correctly

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:

EmailTestResultDto

async kavita_client.api.settings.post_api_settings_test_email_url.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → kavita_client.types.Response[kavita_client.models.email_test_result_dto.EmailTestResultDto]

Sends a test email to see if email settings are hooked up correctly

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[EmailTestResultDto]

kavita_client.api.settings.post_api_settings_test_email_url.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → kavita_client.models.email_test_result_dto.EmailTestResultDto | None

Sends a test email to see if email settings are hooked up correctly

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:

EmailTestResultDto

kavita_client.api.settings.post_api_settings_test_email_url.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → kavita_client.types.Response[kavita_client.models.email_test_result_dto.EmailTestResultDto]

Sends a test email to see if email settings are hooked up correctly

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[EmailTestResultDto]