identity

konigle.managers.comm.email.identity

Email identity managers for the Konigle SDK.

This module provides managers for email identity resources, enabling email identity management operations including CRUD operations and verification handling.

AsyncEmailIdentityManager

Bases: BaseEmailIdentityManager, BaseAsyncManager

Asynchronous manager for email identity resources.

check_verification_status(identity_id) async

Check verification status for an email identity.

PARAMETER	DESCRIPTION
identity_id	ID of the identity to verify TYPE: str

Returns: Updated identity instance with verification status Example:

identity = await client.email_identities.check_verification_status("eid_123")
print(f"Verification status: {identity.verified}")

create(data) async

Create a new email identity.

PARAMETER	DESCRIPTION
data	Email identity creation data including all required fields TYPE: EmailIdentityCreate

RETURNS	DESCRIPTION
EmailIdentity	Created email identity instance with Active Record capabilities

Example

identity_data = EmailIdentityCreate(
    identity_value="example.com",
)
identity = await client.email_identities.create(identity_data)
print(f"Created identity: {identity.identity_value}")

setup_custom_mail_from(identity_id, mail_from_domain) async

Setup custom MAIL FROM domain for an email identity. Args: identity_id: ID of the identity to setup custom MAIL FROM mail_from_domain: Custom MAIL FROM domain to be set Returns: Updated identity instance with custom MAIL FROM domain that is pending verification. The returned instance includes the dns records that need to be added for verification.

BaseEmailIdentityManager

Base class for email identity managers with shared configuration.

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

The API base path for this resource type.

filter_class = EmailIdentityFilters class-attribute instance-attribute

The filter model class for this resource type.

resource_class = EmailIdentity class-attribute instance-attribute

The resource model class this manager handles.

resource_update_class = EmailIdentityUpdate class-attribute instance-attribute

The model class used for updating resources.

EmailIdentityManager

Bases: BaseEmailIdentityManager, BaseSyncManager

Synchronous manager for email identity resources.

check_verification_status(identity_id)

Check verification status for an email identity.

PARAMETER	DESCRIPTION
identity_id	ID of the identity to verify TYPE: str

RETURNS	DESCRIPTION
EmailIdentity	Updated identity instance with verification status

Example

identity = client.email_identities.check_verification_status("eid_123")
print(f"Verification status: {identity.verified}")

create(data)

Create a new email identity.

PARAMETER	DESCRIPTION
data	Email identity creation data including all required fields TYPE: EmailIdentityCreate

RETURNS	DESCRIPTION
EmailIdentity	Created email identity instance with Active Record capabilities

Example

identity_data = EmailIdentityCreate(
    identity_value="example.com",
)
identity = client.email_identities.create(identity_data)
print(f"Created identity: {identity.identity_value}")

setup_custom_mail_from(identity_id, mail_from_domain)

Setup custom MAIL FROM domain for an email identity.

PARAMETER	DESCRIPTION
identity_id	ID of the identity to setup custom MAIL FROM TYPE: str
mail_from_domain	Custom MAIL FROM domain to be set TYPE: str

Returns: Updated identity instance with custom MAIL FROM domain that is pending verification. The returned instance includes the dns records that need to be added for verification.