Skip to content

account

konigle.models.comm.email.account

Email account models for the Konigle SDK.

Email accounts represent the main account container for a website's email configuration, containing default settings and serving as the parent for email channels and identities.

BaseEmailAccount

Bases: BaseModel

default_from_email = Field(default='', title='Default From Email', description='Default from email address for this account.') class-attribute instance-attribute

Default from email address.

default_from_name = Field(default='', title='Default From Name', description='Default from name for email headers.', max_length=255) class-attribute instance-attribute

Default from name.

default_reply_to_email = Field(default='', title='Default Reply-To Email', description='Default reply-to email address.') class-attribute instance-attribute

Default reply-to email address.

default_reply_to_name = Field(default='', title='Default Reply-To Name', description='Default reply-to name for email headers.', max_length=255) class-attribute instance-attribute

Default reply-to name.

name = Field(title='Account Name', description='Name of the email account.', max_length=255) class-attribute instance-attribute

Name of the email account.

EmailAccount

Bases: BaseEmailAccount, TimestampedResource

Email account for a website.

Each website gets one email account that contains the default email configuration and serves as the parent for email channels and identities.

is_active = Field(default=True, title='Is Active', description='Whether the email account is active and can be used.') class-attribute instance-attribute

Whether the email account is active.

EmailAccountCreate

Bases: BaseEmailAccount, CreateModel

Model for creating a new email account.

EmailAccountSetup

Bases: BaseModel

Model for setting up an email account with initial configuration.

account_name = Field(title='Account Name', description='Name of the email account.', max_length=255) class-attribute instance-attribute

Name of the email account.

default_from_email = Field(title='Default From Email', description='Default from email address for this account.') class-attribute instance-attribute

Default from email address.

default_reply_to_email = Field(default=None, title='Default Reply-To Email', description='Default reply-to email address.') class-attribute instance-attribute

Default reply-to email address.

identity_value = Field(title='Identity Value', description='Email address or domain to verify as an identity.', max_length=255) class-attribute instance-attribute

Email address or domain to verify as an identity.

EmailAccountUpdate

Bases: UpdateModel

Model for updating an existing email account.

default_from_email = Field(default=None, title='Default From Email', description='Default from email address for this account.') class-attribute instance-attribute

Default from email address.

default_from_name = Field(default=None, title='Default From Name', description='Default from name for email headers.', max_length=255) class-attribute instance-attribute

Default from name.

default_reply_to_email = Field(default=None, title='Default Reply-To Email', description='Default reply-to email address.') class-attribute instance-attribute

Default reply-to email address.

default_reply_to_name = Field(default=None, title='Default Reply-To Name', description='Default reply-to name for email headers.', max_length=255) class-attribute instance-attribute

Default reply-to name.

name = Field(default=None, title='Account Name', description='Name of the email account.', max_length=255) class-attribute instance-attribute

Name of the email account.