api.v1.serializers.email_serializers.FullEmailSerializer module

Module with the FullEmailSerializer serializer class.

class api.v1.serializers.email_serializers.FullEmailSerializer.FullEmailSerializer(*args, **kwargs)[source]

Bases: BaseEmailSerializer

A complete serializer for a core.models.Email.

Includes nested serializers for the core.models.Email.Email.replies, core.models.Email.Email.attachments and core.models.Email.Email.correspondents foreign key and related fields.

replies: PrimaryKeyRelatedField

The replies mails are included by id only to prevent recursion.

referenced_by: PrimaryKeyRelatedField

The referencing mails are included by id only to prevent recursion.

_declared_fields = {'attachments': BaseAttachmentSerializer(many=True, read_only=True):     id = BigIntegerField(label='ID', read_only=True)     is_favorite = BooleanField(label='Favorite status', required=False)     created = DateTimeField(label='Time of creation', read_only=True)     updated = DateTimeField(label='Time of last update', read_only=True)     file_name = CharField(label='Filename', read_only=True)     content_disposition = CharField(read_only=True)     content_id = CharField(label='Content ID', read_only=True)     content_maintype = CharField(read_only=True)     content_subtype = CharField(read_only=True)     datasize = IntegerField(read_only=True)     email = PrimaryKeyRelatedField(read_only=True), 'correspondents': SerializerMethodField(read_only=True), 'referenced_by': ManyRelatedField(child_relation=PrimaryKeyRelatedField(read_only=True), read_only=True), 'replies': ManyRelatedField(child_relation=PrimaryKeyRelatedField(read_only=True), read_only=True)}
attachments

The attachments are serialized by eonvelope.AttachmentSerializers.BaseAttachmentSerializer.BaseAttachmentSerializer.

correspondents

The emails are set from the core.models.EmailCorrespondent via get_correspondents().

get_correspondents(instance)[source]

Serializes the correspondents connected to the instance to be serialized.

Parameters:

instance (Email) – The instance being serialized.

Return type:

ReturnDict[str, Any]

Returns:

The serialized correspondents connected to the instance to be serialized.