api.v1.serializers.emailcorrespondent_serializers.EmailCorrespondentSerializer module

Module with the EmailCorrespondentSerializer serializer class.

class api.v1.serializers.emailcorrespondent_serializers.EmailCorrespondentSerializer.EmailCorrespondentSerializer(*args, **kwargs)[source]

Bases: BaseEmailCorrespondentSerializer

The serializer for correspondents from core.models.EmailCorrespondent.

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

correspondent

The correspondent is serialized by api.v1.serializers.SimpleCorrespondentSerializer.

class Meta[source]

Bases: Meta

Metadata class for the serializer.

fields: ClassVar[list[str]] = ['correspondent', 'mention']

Includes only core.models.EmailCorrespondent.EmailCorrespondent.correspondent and core.models.EmailCorrespondent.EmailCorrespondent.mention.

_declared_fields = {'correspondent': BaseCorrespondentSerializer(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)     email_address = CharField(read_only=True)     email_name = CharField(help_text='The mailer name of the correspondent.', label='Mailer name', read_only=True, style={'base_template': 'textarea.html'})     real_name = CharField(allow_blank=True, help_text='The real name of the correspondent.', max_length=255, required=False)     list_id = CharField(label='List ID', read_only=True, style={'base_template': 'textarea.html'})     list_owner = CharField(read_only=True, style={'base_template': 'textarea.html'})     list_subscribe = CharField(label='List-subscribe', read_only=True, style={'base_template': 'textarea.html'})     list_unsubscribe = CharField(label='List-unsubscribe', read_only=True, style={'base_template': 'textarea.html'})     list_unsubscribe_post = CharField(label='List-unsubscribe method', read_only=True)     list_post = CharField(read_only=True, style={'base_template': 'textarea.html'})     list_help = CharField(read_only=True, style={'base_template': 'textarea.html'})     list_archive = CharField(read_only=True, style={'base_template': 'textarea.html'})}