account

konigle.managers.comm.email.account

Email account managers for the Konigle SDK.

This module provides managers for email account resources, enabling email account management operations including CRUD operations.

AsyncEmailAccountManager

Bases: BaseEmailAccountManager, BaseAsyncManager

Asynchronous manager for email account resources.

check_status() async

Check the status of the email account to ensure email sending is operational.

RETURNS	DESCRIPTION
Dict[str, Any]	A dictionary containing the status information of the email account.

Example:

status = await client.email_accounts.check_status()
print(f"Email account status: {status}")

create(data) async

Create a new email account.

PARAMETER	DESCRIPTION
data	Email account creation data including all required fields TYPE: EmailAccountCreate

RETURNS	DESCRIPTION
EmailAccount	Created email account instance with Active Record capabilities

Example

account_data = EmailAccountCreate(
    name="Marketing Account",
    default_from_email="noreply@example.com",
    default_from_name="Example Team",
)
account = await client.email_accounts.create(account_data)
print(f"Created account: {account.name}")

setup(data) async

Set up a new email account along with its default channel and identity. Args: data: Email account setup data including all required fields Returns: A dictionary containing the created email account, its default channel, and identity. Example:

setup_data = EmailAccountSetup(
    name="Marketing Account",
    default_from_email=""
    default_reply_to_email=""
    identity_value="example.com",
)
setup_result = await client.email_accounts.setup(setup_data)
account = setup_result["account"]
channel = setup_result["channels"][0]
identity = setup_result["identity"]

BaseEmailAccountManager

Base class for email account managers with shared configuration.

base_path = '/reachout/api/v1/accounts' class-attribute instance-attribute

The API base path for this resource type.

filter_class = EmailAccountFilters class-attribute instance-attribute

The filter model class for this resource type.

resource_class = EmailAccount class-attribute instance-attribute

The resource model class this manager handles.

resource_update_class = EmailAccountUpdate class-attribute instance-attribute

The model class used for updating resources.

EmailAccountManager

Bases: BaseEmailAccountManager, BaseSyncManager

Synchronous manager for email account resources.

check_status()

Check the status of the email account to ensure email sending is operational.

RETURNS	DESCRIPTION
Dict[str, Any]	A dictionary containing the status information of the email account.

Example

status = client.email_accounts.check_status()
print(f"Email account status: {status}")

create(data)

Create a new email account.

PARAMETER	DESCRIPTION
data	Email account creation data including all required fields TYPE: EmailAccountCreate

RETURNS	DESCRIPTION
EmailAccount	Created email account instance with Active Record capabilities

Example

account_data = EmailAccountCreate(
    name="Marketing Account",
    default_from_email="noreply@example.com",
    default_from_name="Example Team",
)
account = client.email_accounts.create(account_data)
print(f"Created account: {account.name}")

setup(data)

Set up a new email account along with its default channel and identity. Args: data: Email account setup data including all required fields Returns: A dictionary containing the created email account, its default channel, and identity. Example:

setup_data = EmailAccountSetup(
    name="Marketing Account",
    default_from_email=""
    default_reply_to_email=""
    identity_value="example.com",
)
setup_result = client.email_accounts.setup(setup_data)
account = setup_result["account"]
channel = setup_result["channels"][0]
identity = setup_result["identity"]