api.v1.serializers.email_serializers.BaseEmailSerializer module

Module with the BaseEmailSerializer serializer class.

class api.v1.serializers.email_serializers.BaseEmailSerializer.BaseEmailSerializer(*args, **kwargs)

Bases: ModelSerializer

The base serializer for core.models.Email.

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

class Meta

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 and exclude must not be shortened in subclasses.

model

The model to serialize.

alias of Email

exclude: ClassVar[list[str]] = ['file_path']

Exclude the core.models.Email.Email.file_path field.

read_only_fields: Final[list[str]] = ['message_id', 'datetime', 'subject', 'plain_bodytext', 'html_bodytext', 'in_reply_to', 'references', 'datasize', 'correspondents', 'mailbox', 'headers', 'x_spam_flag', 'created', 'updated']

All fields except for core.models.Email.Email.is_favorite are read-only.

_declared_fields = {}