identity
konigle.models.comm.email.identity
¶
Email identity models for the Konigle SDK.
Email identities represent domains or email addresses that have been verified for sending emails, including DKIM and SPF configuration.
EmailIdentity
¶
Bases: TimestampedResource
Identities (domains or email addresses) for sending emails.
Identities must be verified before they can be used to send emails. This includes DKIM and SPF verification for domains.
account = Field(title='Account ID', description='ID of the email account this identity belongs to.')
class-attribute
instance-attribute
¶
Email account this identity belongs to.
dkim_records = Field(default_factory=list, title='DKIM Records', description='DKIM DNS records to be added for verification.')
class-attribute
instance-attribute
¶
DKIM DNS records to be added for verification.
dkim_verification_status = Field(default=(EmailVerificationStatus.PENDING), title='DKIM Verification Status', description='DKIM verification status.')
class-attribute
instance-attribute
¶
DKIM verification status.
dkim_verified = Field(default=False, title='DKIM Verified', description='Whether DKIM is verified.')
class-attribute
instance-attribute
¶
Whether DKIM is verified.
identity_type = Field(title='Identity Type', description='Type of identity (domain or email).')
class-attribute
instance-attribute
¶
Type of identity (domain or email).
identity_value = Field(title='Identity Value', description='The domain or email address value.', max_length=255)
class-attribute
instance-attribute
¶
The domain or email address value.
mail_from_domain = Field(default=None, title='MAIL FROM Domain', description='Custom MAIL FROM domain used for envelope sender.', max_length=255)
class-attribute
instance-attribute
¶
Custom MAIL FROM domain used for envelope sender.
mail_from_records = Field(default_factory=list, title='MAIL FROM Records', description='MAIL FROM DNS records to be added for verification.')
class-attribute
instance-attribute
¶
MAIL FROM DNS records to be added for verification.
mail_from_verification_status = Field(default=(EmailVerificationStatus.PENDING), title='MAIL FROM Verification Status', description='MAIL FROM domain verification status. This is SPF verification status.')
class-attribute
instance-attribute
¶
MAIL FROM domain verification status. This is SPF verification status.
mail_from_verified = Field(default=False, title='MAIL FROM Verified', description='Whether MAIL FROM domain is verified.')
class-attribute
instance-attribute
¶
Whether MAIL FROM domain is verified.
use_custom_mail_from = Field(default=False, title='Use Custom MAIL FROM', description='Whether to use custom MAIL FROM domain.')
class-attribute
instance-attribute
¶
Whether to use custom MAIL FROM domain.
verified = Field(default=False, title='Verified', description='Whether the identity is verified for sending emails.')
class-attribute
instance-attribute
¶
Whether the identity is verified for sending emails.
EmailIdentityCreate
¶
Bases: CreateModel
Model for creating a new email identity.
identity_value = Field(title='Identity Value', description='The domain or email address value.', max_length=255)
class-attribute
instance-attribute
¶
The domain or email address value.
EmailIdentityType
¶
EmailIdentityUpdate
¶
Bases: UpdateModel
Model for updating an existing email identity.
use_custom_mail_from = Field(default=None, title='Use Custom MAIL FROM', description='Whether to use custom MAIL FROM domain.')
class-attribute
instance-attribute
¶
Whether to use custom MAIL FROM domain.