thunderbird_accounts.authentication.models

Classes

AllowListEntry(*args, **kwargs)	Allow List Entry
User(*args, **kwargs)

class thunderbird_accounts.authentication.models.User(*args, **kwargs)

Bases: AbstractUser, BaseModel

Parameters:

• username – The thundermail address, aligns with keycloak’s usage of username.

• oidc_id – The ID of the connected oidc account

• last_used_email – The last used email associated with this account

• language – The user’s preferred language to view the ui/system emails in

• display_name – Display name from oidc profile

• avatar_url – Avatar URL from oidc profile

• timezone – The user’s timezone

• password (CharField) – Password

• last_login (DateTimeField) – Last login

• is_superuser (BooleanField) – Superuser status. Designates that this user has all permissions without explicitly assigning them.

• first_name (CharField) – First name

• last_name (CharField) – Last name

• email (EmailField) – Email address

• is_staff (BooleanField) – Staff status. Designates whether the user can log into this admin site.

• is_active (BooleanField) – Active. Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

• date_joined (DateTimeField) – Date joined

• uuid (UUIDField) – Primary key: Uuid

• created_at (DateTimeField) – Created at

• updated_at (DateTimeField) – Updated at

• is_test_account (BooleanField) – Test Account. Whether this account is used for testing.

• is_awaiting_payment_verification (BooleanField) – Is awaiting payment verification. The user has paid and we’re waiting on Paddle to verify the payment was successful.<br><b>Note:</b> Please do not override this unless authorized.

Relationship fields:

Parameters:

• plan (ForeignKey to Plan) – Plan (related name: user)

• groups (ManyToManyField to Group) – Groups. The groups this user belongs to. A user will get all permissions granted to each of their groups. (related name: user_set)

• user_permissions (ManyToManyField to Permission) – User permissions. Specific permissions for this user. (related name: user_set)

Reverse relationships:

Parameters:

• allowlistentry (Reverse ForeignKey from AllowListEntry) – All Allow list entries of this user (related name of user)

• subscription (Reverse ForeignKey from Subscription) – All subscriptions of this user (related name of user)

• account (Reverse ForeignKey from Account) – All accounts of this user (related name of user)

• domains (Reverse ForeignKey from Domain) – All domains of this user (related name of user)

• logentry (Reverse ForeignKey from LogEntry) – All log entries of this user (related name of user)

class UserLanguageType(*values)

Bases: TextChoices

has_usable_password()

Disable passwords for oidc

get_short_name()

Return the short name for the user.

property stalwart_primary_email: str | None

Returns the primary email address used for Stalwart.

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

class thunderbird_accounts.authentication.models.AllowListEntry(*args, **kwargs)

Bases: BaseModel

Allow List Entry

This is a small model that holds an email address and a user_id. If an email address on a AllowListEntry is in the db then that user can successfully sign-up and move onto the Subscribe screen. Otherwise, they’ll just see the wait list.

If a user is created from an allow list entry their user will generally be populated in the user_id field / user relationship. (Unless they’re created by outside means.)

Parameters:

• uuid (UUIDField) – Primary key: Uuid

• created_at (DateTimeField) – Created at

• updated_at (DateTimeField) – Updated at

• email (EmailField) – Email address

Relationship fields:

Parameters:

user (ForeignKey to User) – User. The user associated with this allow list entry, if any. (related name: allowlistentry)

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned