api.v1.serializers.mailbox_serializers.BaseMailboxSerializer module

Module with the BaseMailboxSerializer serializer class.

class api.v1.serializers.mailbox_serializers.BaseMailboxSerializer.BaseMailboxSerializer(*args, **kwargs)[source]

Bases: ModelSerializer

The base serializer for core.models.Mailbox.

Includes all viable fields from the model. Sets all constraints that must be implemented in all serializers. Other serializers for core.models.Mailbox should inherit from this.

class Meta[source]

Bases: object

Metadata class for the base serializer.

Contains constraints that must be implemented by all serializers. Other serializer metaclasses should inherit from this. read_only_fields must not be shortened in subclasses.

model

The model to serialize.

alias of Mailbox

fields = '__all__'

Includes all fields.

read_only_fields: Final[list[str]] = ['name', 'type', 'account', 'is_healthy', 'last_error', 'last_error_occurred_at', 'created', 'updated']

The core.models.Mailbox.Mailbox.name, core.models.Mailbox.Mailbox.type, core.models.Mailbox.Mailbox.account, core.models.Mailbox.Mailbox.is_healthy, core.models.Mailbox.Mailbox.created and core.models.Mailbox.Mailbox.updated fields are read-only.

_declared_fields = {}