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)

Slim representation of a Stalwart individual account (inbox).

BaseStalwartObject(*args, **kwargs)

Models that link to Stalwart principal objects should use this as the base class

Email(*args, **kwargs)

Slim representation of a Stalwart email address.

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.BaseStalwartObject(*args, **kwargs)[source]

Bases: BaseModel

Models that link to Stalwart principal objects should use this as the base class

Parameters:

  • uuid (UUIDField) – Primary key: Uuid

  • created_at (DateTimeField) – Created at

  • updated_at (DateTimeField) – Updated at

  • stalwart_id (CharField) – Stalwart id. The unique ID in Stalwart. (Note: That this isn’t useful for anything besides verifying that it exists in Stalwart.

  • stalwart_created_at (DateTimeField) – Stalwart created at. Date that this object was created by this system in Stalwart.

  • stalwart_updated_at (DateTimeField) – Stalwart updated at. Date that this object was last updated by this system in Stalwart.

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

Bases: BaseStalwartObject

Slim representation of a Stalwart individual account (inbox).

Parameters:

  • uuid (UUIDField) – Primary key: Uuid

  • created_at (DateTimeField) – Created at

  • updated_at (DateTimeField) – Updated at

  • stalwart_id (CharField) – Stalwart id. The unique ID in Stalwart. (Note: That this isn’t useful for anything besides verifying that it exists in Stalwart.

  • stalwart_created_at (DateTimeField) – Stalwart created at. Date that this object was created by this system in Stalwart.

  • stalwart_updated_at (DateTimeField) – Stalwart updated at. Date that this object was last updated by this system in Stalwart.

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

  • active (BooleanField) – Active

Relationship fields:

Parameters:

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

Reverse relationships:

Parameters:

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

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

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

Bases: BaseModel

Slim representation of a Stalwart email address. one primary, and many aliases all connected to one account (inbox).

Parameters:

  • uuid (UUIDField) – Primary key: Uuid

  • created_at (DateTimeField) – Created at

  • updated_at (DateTimeField) – Updated at

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

  • type (TextField) – Type

Relationship fields:

Parameters:

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

class EmailType(*values)[source]

Bases: TextChoices

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned