Source code for api.v1.serializers.emailcorrespondent_serializers.EmailCorrespondentSerializer

# SPDX-License-Identifier: AGPL-3.0-or-later
#
# Eonvelope - a open-source self-hostable email archiving server
# Copyright (C) 2024 David Aderbauer & The Eonvelope Contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.

"""Module with the :class:`EmailCorrespondentSerializer` serializer class."""

from __future__ import annotations

from typing import ClassVar

from api.v1.serializers.correspondent_serializers.BaseCorrespondentSerializer import (
    BaseCorrespondentSerializer,
)

from .BaseEmailCorrespondentSerializer import BaseEmailCorrespondentSerializer




[docs]
class EmailCorrespondentSerializer(BaseEmailCorrespondentSerializer):
    """The serializer for correspondents from :class:`core.models.EmailCorrespondent`.

    Used to serialize the correspondent belonging to an email. Does not include that email.
    """

    correspondent = BaseCorrespondentSerializer(read_only=True)
    """The correspondent is serialized
    by :class:`api.v1.serializers.SimpleCorrespondentSerializer`.
    """



[docs]
    class Meta(BaseEmailCorrespondentSerializer.Meta):
        """Metadata class for the serializer."""

        fields: ClassVar[list[str]] = ["correspondent", "mention"]
        """Includes only
        :attr:`core.models.EmailCorrespondent.EmailCorrespondent.correspondent`
        and :attr:`core.models.EmailCorrespondent.EmailCorrespondent.mention`.
        """