Module mailslurp_client.models.email_draft_dto

MailSlurp API

MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - Homepage - Get an API KEY - Generated SDK Clients - Examples repository # noqa: E501

The version of the OpenAPI document: 6.5.2 Contact: contact@mailslurp.dev Generated by: https://openapi-generator.tech

Classes

class EmailDraftDto (id=None, user_id=None, inbox_id=None, to=None, cc=None, bcc=None, sender=None, recipients=None, subject=None, body_excerpt=None, text_excerpt=None, attachments=None, send_options=None, created_at=None, updated_at=None, local_vars_configuration=None)

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

EmailDraftDto - a model defined in OpenAPI

Expand source code

class EmailDraftDto(object):
    """NOTE: This class is auto generated by OpenAPI Generator.
    Ref: https://openapi-generator.tech

    Do not edit the class manually.
    """

    """
    Attributes:
      openapi_types (dict): The key is attribute name
                            and the value is attribute type.
      attribute_map (dict): The key is attribute name
                            and the value is json key in definition.
    """
    openapi_types = {
        'id': 'str',
        'user_id': 'str',
        'inbox_id': 'str',
        'to': 'list[str]',
        'cc': 'list[str]',
        'bcc': 'list[str]',
        '_from': 'str',
        'sender': 'Sender',
        'recipients': 'EmailRecipients',
        'subject': 'str',
        'body_excerpt': 'str',
        'text_excerpt': 'str',
        'attachments': 'list[str]',
        'send_options': 'SendEmailOptions',
        'created_at': 'datetime',
        'updated_at': 'datetime'
    }

    attribute_map = {
        'id': 'id',
        'user_id': 'userId',
        'inbox_id': 'inboxId',
        'to': 'to',
        'cc': 'cc',
        'bcc': 'bcc',
        '_from': 'from',
        'sender': 'sender',
        'recipients': 'recipients',
        'subject': 'subject',
        'body_excerpt': 'bodyExcerpt',
        'text_excerpt': 'textExcerpt',
        'attachments': 'attachments',
        'send_options': 'sendOptions',
        'created_at': 'createdAt',
        'updated_at': 'updatedAt'
    }

    def __init__(self, id=None, user_id=None, inbox_id=None, to=None, cc=None, bcc=None, _from=None, sender=None, recipients=None, subject=None, body_excerpt=None, text_excerpt=None, attachments=None, send_options=None, created_at=None, updated_at=None, local_vars_configuration=None):  # noqa: E501
        """EmailDraftDto - a model defined in OpenAPI"""  # noqa: E501
        if local_vars_configuration is None:
            local_vars_configuration = Configuration()
        self.local_vars_configuration = local_vars_configuration

        self._id = None
        self._user_id = None
        self._inbox_id = None
        self._to = None
        self._cc = None
        self._bcc = None
        self.__from = None
        self._sender = None
        self._recipients = None
        self._subject = None
        self._body_excerpt = None
        self._text_excerpt = None
        self._attachments = None
        self._send_options = None
        self._created_at = None
        self._updated_at = None
        self.discriminator = None

        self.id = id
        self.user_id = user_id
        self.inbox_id = inbox_id
        self.to = to
        self.cc = cc
        self.bcc = bcc
        self._from = _from
        self.sender = sender
        self.recipients = recipients
        self.subject = subject
        self.body_excerpt = body_excerpt
        self.text_excerpt = text_excerpt
        self.attachments = attachments
        self.send_options = send_options
        self.created_at = created_at
        self.updated_at = updated_at

    @property
    def id(self):
        """Gets the id of this EmailDraftDto.  # noqa: E501

        ID of the draft  # noqa: E501

        :return: The id of this EmailDraftDto.  # noqa: E501
        :rtype: str
        """
        return self._id

    @id.setter
    def id(self, id):
        """Sets the id of this EmailDraftDto.

        ID of the draft  # noqa: E501

        :param id: The id of this EmailDraftDto.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and id is None:  # noqa: E501
            raise ValueError("Invalid value for `id`, must not be `None`")  # noqa: E501

        self._id = id

    @property
    def user_id(self):
        """Gets the user_id of this EmailDraftDto.  # noqa: E501

        User ID  # noqa: E501

        :return: The user_id of this EmailDraftDto.  # noqa: E501
        :rtype: str
        """
        return self._user_id

    @user_id.setter
    def user_id(self, user_id):
        """Sets the user_id of this EmailDraftDto.

        User ID  # noqa: E501

        :param user_id: The user_id of this EmailDraftDto.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and user_id is None:  # noqa: E501
            raise ValueError("Invalid value for `user_id`, must not be `None`")  # noqa: E501

        self._user_id = user_id

    @property
    def inbox_id(self):
        """Gets the inbox_id of this EmailDraftDto.  # noqa: E501

        Inbox ID the draft will send from  # noqa: E501

        :return: The inbox_id of this EmailDraftDto.  # noqa: E501
        :rtype: str
        """
        return self._inbox_id

    @inbox_id.setter
    def inbox_id(self, inbox_id):
        """Sets the inbox_id of this EmailDraftDto.

        Inbox ID the draft will send from  # noqa: E501

        :param inbox_id: The inbox_id of this EmailDraftDto.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and inbox_id is None:  # noqa: E501
            raise ValueError("Invalid value for `inbox_id`, must not be `None`")  # noqa: E501

        self._inbox_id = inbox_id

    @property
    def to(self):
        """Gets the to of this EmailDraftDto.  # noqa: E501

        Draft recipients  # noqa: E501

        :return: The to of this EmailDraftDto.  # noqa: E501
        :rtype: list[str]
        """
        return self._to

    @to.setter
    def to(self, to):
        """Sets the to of this EmailDraftDto.

        Draft recipients  # noqa: E501

        :param to: The to of this EmailDraftDto.  # noqa: E501
        :type: list[str]
        """

        self._to = to

    @property
    def cc(self):
        """Gets the cc of this EmailDraftDto.  # noqa: E501

        Draft CC recipients  # noqa: E501

        :return: The cc of this EmailDraftDto.  # noqa: E501
        :rtype: list[str]
        """
        return self._cc

    @cc.setter
    def cc(self, cc):
        """Sets the cc of this EmailDraftDto.

        Draft CC recipients  # noqa: E501

        :param cc: The cc of this EmailDraftDto.  # noqa: E501
        :type: list[str]
        """

        self._cc = cc

    @property
    def bcc(self):
        """Gets the bcc of this EmailDraftDto.  # noqa: E501

        Draft BCC recipients  # noqa: E501

        :return: The bcc of this EmailDraftDto.  # noqa: E501
        :rtype: list[str]
        """
        return self._bcc

    @bcc.setter
    def bcc(self, bcc):
        """Sets the bcc of this EmailDraftDto.

        Draft BCC recipients  # noqa: E501

        :param bcc: The bcc of this EmailDraftDto.  # noqa: E501
        :type: list[str]
        """

        self._bcc = bcc

    @property
    def _from(self):
        """Gets the _from of this EmailDraftDto.  # noqa: E501

        Draft sender  # noqa: E501

        :return: The _from of this EmailDraftDto.  # noqa: E501
        :rtype: str
        """
        return self.__from

    @_from.setter
    def _from(self, _from):
        """Sets the _from of this EmailDraftDto.

        Draft sender  # noqa: E501

        :param _from: The _from of this EmailDraftDto.  # noqa: E501
        :type: str
        """

        self.__from = _from

    @property
    def sender(self):
        """Gets the sender of this EmailDraftDto.  # noqa: E501


        :return: The sender of this EmailDraftDto.  # noqa: E501
        :rtype: Sender
        """
        return self._sender

    @sender.setter
    def sender(self, sender):
        """Sets the sender of this EmailDraftDto.


        :param sender: The sender of this EmailDraftDto.  # noqa: E501
        :type: Sender
        """

        self._sender = sender

    @property
    def recipients(self):
        """Gets the recipients of this EmailDraftDto.  # noqa: E501


        :return: The recipients of this EmailDraftDto.  # noqa: E501
        :rtype: EmailRecipients
        """
        return self._recipients

    @recipients.setter
    def recipients(self, recipients):
        """Sets the recipients of this EmailDraftDto.


        :param recipients: The recipients of this EmailDraftDto.  # noqa: E501
        :type: EmailRecipients
        """

        self._recipients = recipients

    @property
    def subject(self):
        """Gets the subject of this EmailDraftDto.  # noqa: E501

        Draft subject  # noqa: E501

        :return: The subject of this EmailDraftDto.  # noqa: E501
        :rtype: str
        """
        return self._subject

    @subject.setter
    def subject(self, subject):
        """Sets the subject of this EmailDraftDto.

        Draft subject  # noqa: E501

        :param subject: The subject of this EmailDraftDto.  # noqa: E501
        :type: str
        """

        self._subject = subject

    @property
    def body_excerpt(self):
        """Gets the body_excerpt of this EmailDraftDto.  # noqa: E501

        Draft body preview  # noqa: E501

        :return: The body_excerpt of this EmailDraftDto.  # noqa: E501
        :rtype: str
        """
        return self._body_excerpt

    @body_excerpt.setter
    def body_excerpt(self, body_excerpt):
        """Sets the body_excerpt of this EmailDraftDto.

        Draft body preview  # noqa: E501

        :param body_excerpt: The body_excerpt of this EmailDraftDto.  # noqa: E501
        :type: str
        """

        self._body_excerpt = body_excerpt

    @property
    def text_excerpt(self):
        """Gets the text_excerpt of this EmailDraftDto.  # noqa: E501

        Draft text preview  # noqa: E501

        :return: The text_excerpt of this EmailDraftDto.  # noqa: E501
        :rtype: str
        """
        return self._text_excerpt

    @text_excerpt.setter
    def text_excerpt(self, text_excerpt):
        """Sets the text_excerpt of this EmailDraftDto.

        Draft text preview  # noqa: E501

        :param text_excerpt: The text_excerpt of this EmailDraftDto.  # noqa: E501
        :type: str
        """

        self._text_excerpt = text_excerpt

    @property
    def attachments(self):
        """Gets the attachments of this EmailDraftDto.  # noqa: E501

        Attachment IDs selected for the draft  # noqa: E501

        :return: The attachments of this EmailDraftDto.  # noqa: E501
        :rtype: list[str]
        """
        return self._attachments

    @attachments.setter
    def attachments(self, attachments):
        """Sets the attachments of this EmailDraftDto.

        Attachment IDs selected for the draft  # noqa: E501

        :param attachments: The attachments of this EmailDraftDto.  # noqa: E501
        :type: list[str]
        """

        self._attachments = attachments

    @property
    def send_options(self):
        """Gets the send_options of this EmailDraftDto.  # noqa: E501


        :return: The send_options of this EmailDraftDto.  # noqa: E501
        :rtype: SendEmailOptions
        """
        return self._send_options

    @send_options.setter
    def send_options(self, send_options):
        """Sets the send_options of this EmailDraftDto.


        :param send_options: The send_options of this EmailDraftDto.  # noqa: E501
        :type: SendEmailOptions
        """
        if self.local_vars_configuration.client_side_validation and send_options is None:  # noqa: E501
            raise ValueError("Invalid value for `send_options`, must not be `None`")  # noqa: E501

        self._send_options = send_options

    @property
    def created_at(self):
        """Gets the created_at of this EmailDraftDto.  # noqa: E501

        Draft creation time  # noqa: E501

        :return: The created_at of this EmailDraftDto.  # noqa: E501
        :rtype: datetime
        """
        return self._created_at

    @created_at.setter
    def created_at(self, created_at):
        """Sets the created_at of this EmailDraftDto.

        Draft creation time  # noqa: E501

        :param created_at: The created_at of this EmailDraftDto.  # noqa: E501
        :type: datetime
        """
        if self.local_vars_configuration.client_side_validation and created_at is None:  # noqa: E501
            raise ValueError("Invalid value for `created_at`, must not be `None`")  # noqa: E501

        self._created_at = created_at

    @property
    def updated_at(self):
        """Gets the updated_at of this EmailDraftDto.  # noqa: E501

        Draft last update time  # noqa: E501

        :return: The updated_at of this EmailDraftDto.  # noqa: E501
        :rtype: datetime
        """
        return self._updated_at

    @updated_at.setter
    def updated_at(self, updated_at):
        """Sets the updated_at of this EmailDraftDto.

        Draft last update time  # noqa: E501

        :param updated_at: The updated_at of this EmailDraftDto.  # noqa: E501
        :type: datetime
        """
        if self.local_vars_configuration.client_side_validation and updated_at is None:  # noqa: E501
            raise ValueError("Invalid value for `updated_at`, must not be `None`")  # noqa: E501

        self._updated_at = updated_at

    def to_dict(self):
        """Returns the model properties as a dict"""
        result = {}

        for attr, _ in six.iteritems(self.openapi_types):
            value = getattr(self, attr)
            if isinstance(value, list):
                result[attr] = list(map(
                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
                    value
                ))
            elif hasattr(value, "to_dict"):
                result[attr] = value.to_dict()
            elif isinstance(value, dict):
                result[attr] = dict(map(
                    lambda item: (item[0], item[1].to_dict())
                    if hasattr(item[1], "to_dict") else item,
                    value.items()
                ))
            else:
                result[attr] = value

        return result

    def to_str(self):
        """Returns the string representation of the model"""
        return pprint.pformat(self.to_dict())

    def __repr__(self):
        """For `print` and `pprint`"""
        return self.to_str()

    def __eq__(self, other):
        """Returns true if both objects are equal"""
        if not isinstance(other, EmailDraftDto):
            return False

        return self.to_dict() == other.to_dict()

    def __ne__(self, other):
        """Returns true if both objects are not equal"""
        if not isinstance(other, EmailDraftDto):
            return True

        return self.to_dict() != other.to_dict()

Class variables

var attribute_map

var openapi_types

Instance variables

prop attachments

Gets the attachments of this EmailDraftDto. # noqa: E501

Attachment IDs selected for the draft # noqa: E501

:return: The attachments of this EmailDraftDto. # noqa: E501 :rtype: list[str]

Expand source code

@property
def attachments(self):
    """Gets the attachments of this EmailDraftDto.  # noqa: E501

    Attachment IDs selected for the draft  # noqa: E501

    :return: The attachments of this EmailDraftDto.  # noqa: E501
    :rtype: list[str]
    """
    return self._attachments

prop bcc

Gets the bcc of this EmailDraftDto. # noqa: E501

Draft BCC recipients # noqa: E501

:return: The bcc of this EmailDraftDto. # noqa: E501 :rtype: list[str]

Expand source code

@property
def bcc(self):
    """Gets the bcc of this EmailDraftDto.  # noqa: E501

    Draft BCC recipients  # noqa: E501

    :return: The bcc of this EmailDraftDto.  # noqa: E501
    :rtype: list[str]
    """
    return self._bcc

prop body_excerpt

Gets the body_excerpt of this EmailDraftDto. # noqa: E501

Draft body preview # noqa: E501

:return: The body_excerpt of this EmailDraftDto. # noqa: E501 :rtype: str

Expand source code

@property
def body_excerpt(self):
    """Gets the body_excerpt of this EmailDraftDto.  # noqa: E501

    Draft body preview  # noqa: E501

    :return: The body_excerpt of this EmailDraftDto.  # noqa: E501
    :rtype: str
    """
    return self._body_excerpt

prop cc

Gets the cc of this EmailDraftDto. # noqa: E501

Draft CC recipients # noqa: E501

:return: The cc of this EmailDraftDto. # noqa: E501 :rtype: list[str]

Expand source code

@property
def cc(self):
    """Gets the cc of this EmailDraftDto.  # noqa: E501

    Draft CC recipients  # noqa: E501

    :return: The cc of this EmailDraftDto.  # noqa: E501
    :rtype: list[str]
    """
    return self._cc

prop created_at

Gets the created_at of this EmailDraftDto. # noqa: E501

Draft creation time # noqa: E501

:return: The created_at of this EmailDraftDto. # noqa: E501 :rtype: datetime

Expand source code

@property
def created_at(self):
    """Gets the created_at of this EmailDraftDto.  # noqa: E501

    Draft creation time  # noqa: E501

    :return: The created_at of this EmailDraftDto.  # noqa: E501
    :rtype: datetime
    """
    return self._created_at

prop id

Gets the id of this EmailDraftDto. # noqa: E501

ID of the draft # noqa: E501

:return: The id of this EmailDraftDto. # noqa: E501 :rtype: str

Expand source code

@property
def id(self):
    """Gets the id of this EmailDraftDto.  # noqa: E501

    ID of the draft  # noqa: E501

    :return: The id of this EmailDraftDto.  # noqa: E501
    :rtype: str
    """
    return self._id

prop inbox_id

Gets the inbox_id of this EmailDraftDto. # noqa: E501

Inbox ID the draft will send from # noqa: E501

:return: The inbox_id of this EmailDraftDto. # noqa: E501 :rtype: str

Expand source code

@property
def inbox_id(self):
    """Gets the inbox_id of this EmailDraftDto.  # noqa: E501

    Inbox ID the draft will send from  # noqa: E501

    :return: The inbox_id of this EmailDraftDto.  # noqa: E501
    :rtype: str
    """
    return self._inbox_id

prop recipients

Gets the recipients of this EmailDraftDto. # noqa: E501

:return: The recipients of this EmailDraftDto. # noqa: E501 :rtype: EmailRecipients

Expand source code

@property
def recipients(self):
    """Gets the recipients of this EmailDraftDto.  # noqa: E501


    :return: The recipients of this EmailDraftDto.  # noqa: E501
    :rtype: EmailRecipients
    """
    return self._recipients

prop send_options

Gets the send_options of this EmailDraftDto. # noqa: E501

:return: The send_options of this EmailDraftDto. # noqa: E501 :rtype: SendEmailOptions

Expand source code

@property
def send_options(self):
    """Gets the send_options of this EmailDraftDto.  # noqa: E501


    :return: The send_options of this EmailDraftDto.  # noqa: E501
    :rtype: SendEmailOptions
    """
    return self._send_options

prop sender

Gets the sender of this EmailDraftDto. # noqa: E501

:return: The sender of this EmailDraftDto. # noqa: E501 :rtype: Sender

Expand source code

@property
def sender(self):
    """Gets the sender of this EmailDraftDto.  # noqa: E501


    :return: The sender of this EmailDraftDto.  # noqa: E501
    :rtype: Sender
    """
    return self._sender

prop subject

Gets the subject of this EmailDraftDto. # noqa: E501

Draft subject # noqa: E501

:return: The subject of this EmailDraftDto. # noqa: E501 :rtype: str

Expand source code

@property
def subject(self):
    """Gets the subject of this EmailDraftDto.  # noqa: E501

    Draft subject  # noqa: E501

    :return: The subject of this EmailDraftDto.  # noqa: E501
    :rtype: str
    """
    return self._subject

prop text_excerpt

Gets the text_excerpt of this EmailDraftDto. # noqa: E501

Draft text preview # noqa: E501

:return: The text_excerpt of this EmailDraftDto. # noqa: E501 :rtype: str

Expand source code

@property
def text_excerpt(self):
    """Gets the text_excerpt of this EmailDraftDto.  # noqa: E501

    Draft text preview  # noqa: E501

    :return: The text_excerpt of this EmailDraftDto.  # noqa: E501
    :rtype: str
    """
    return self._text_excerpt

prop to

Gets the to of this EmailDraftDto. # noqa: E501

Draft recipients # noqa: E501

:return: The to of this EmailDraftDto. # noqa: E501 :rtype: list[str]

Expand source code

@property
def to(self):
    """Gets the to of this EmailDraftDto.  # noqa: E501

    Draft recipients  # noqa: E501

    :return: The to of this EmailDraftDto.  # noqa: E501
    :rtype: list[str]
    """
    return self._to

prop updated_at

Gets the updated_at of this EmailDraftDto. # noqa: E501

Draft last update time # noqa: E501

:return: The updated_at of this EmailDraftDto. # noqa: E501 :rtype: datetime

Expand source code

@property
def updated_at(self):
    """Gets the updated_at of this EmailDraftDto.  # noqa: E501

    Draft last update time  # noqa: E501

    :return: The updated_at of this EmailDraftDto.  # noqa: E501
    :rtype: datetime
    """
    return self._updated_at

prop user_id

Gets the user_id of this EmailDraftDto. # noqa: E501

User ID # noqa: E501

:return: The user_id of this EmailDraftDto. # noqa: E501 :rtype: str

Expand source code

@property
def user_id(self):
    """Gets the user_id of this EmailDraftDto.  # noqa: E501

    User ID  # noqa: E501

    :return: The user_id of this EmailDraftDto.  # noqa: E501
    :rtype: str
    """
    return self._user_id

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model