thunderbird_accounts.mail.models

Stalwart models live here Schema is based on init scripts: https://stalw.art/docs/storage/backends/postgresql#initialization-statements

Classes

Account(*args, **kwargs)

The Stalwart account model

Email(name, address, type, django_pk)

GroupMember(name, member_of, django_pk)

SmallTextField(*args[, db_collation])

A TextArea field with a CharField-sized widget
class thunderbird_accounts.mail.models.SmallTextField(*args, db_collation=None, **kwargs)[source]

Bases: TextField

A TextArea field with a CharField-sized widget

formfield(**kwargs)[source]

Return a django.forms.Field instance for this field.

class thunderbird_accounts.mail.models.Account(*args, **kwargs)[source]

Bases: Model

The Stalwart account model

Parameters:

  • name (SmallTextField) – Name. The account name (this must be unique.)

  • description (TextField) – Description. The account description (used in groups.)

  • secret (TextField) – Secret. Text area of account secrets (password, app password, etc…)<br/> App Passwords must be in the format of <pre>$app$app_password_name$hashed_app_password</pre><br/> So with a password of test it could be: <pre>$app$Thunderbird$(hashed password goes here)</pre>

  • type (TextField) – Type

  • quota (IntegerField) – Quota

  • active (BooleanField) – Active

  • django_pk (UUIDField) – Primary key: Django pk

Relationship fields:

Parameters:

django_user (ForeignKey to User) – Django user (related name: account)

Reverse relationships:

Parameters:

  • groupmember (Reverse ForeignKey from GroupMember) – All group members of this account (related name of name)

  • email (Reverse ForeignKey from Email) – All emails of this account (related name of name)

class AccountType(*values)[source]

Bases: TextChoices

property app_passwords: list[str]

A list of app password labels

save_app_password(label, password)[source]

Hashes a given password, formats it with the label and saves it to the secret field.

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

class thunderbird_accounts.mail.models.GroupMember(name, member_of, django_pk)[source]

Bases: Model

Parameters:

  • member_of (TextField) – Member of. The name of a group account (an account with the type of <b>group</b>.)

  • django_pk (UUIDField) – Primary key: Django pk

Relationship fields:

Parameters:

name (ForeignKey to Account) – Name (related name: groupmember)

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

class thunderbird_accounts.mail.models.Email(name, address, type, django_pk)[source]

Bases: Model

Parameters:

  • address (SmallTextField) – Address. Full email address.

  • type (TextField) – Type

  • django_pk (UUIDField) – Primary key: Django pk

Relationship fields:

Parameters:

name (ForeignKey to Account) – Name (related name: email)

class EmailType(*values)[source]

Bases: TextChoices

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned