Module mailslurp_client.models.reply_to_email_options

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 ReplyToEmailOptions (body=None, is_html=None, reply_to=None, custom_headers=None, charset=None, attachments=None, template_variables=None, template=None, send_strategy=None, use_inbox_name=None, html=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.

ReplyToEmailOptions - a model defined in OpenAPI

Expand source code

class ReplyToEmailOptions(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 = {
        'body': 'str',
        'is_html': 'bool',
        '_from': 'str',
        'reply_to': 'str',
        'custom_headers': 'dict(str, str)',
        'charset': 'str',
        'attachments': 'list[str]',
        'template_variables': 'dict(str, object)',
        'template': 'str',
        'send_strategy': 'str',
        'use_inbox_name': 'bool',
        'html': 'bool'
    }

    attribute_map = {
        'body': 'body',
        'is_html': 'isHTML',
        '_from': 'from',
        'reply_to': 'replyTo',
        'custom_headers': 'customHeaders',
        'charset': 'charset',
        'attachments': 'attachments',
        'template_variables': 'templateVariables',
        'template': 'template',
        'send_strategy': 'sendStrategy',
        'use_inbox_name': 'useInboxName',
        'html': 'html'
    }

    def __init__(self, body=None, is_html=None, _from=None, reply_to=None, custom_headers=None, charset=None, attachments=None, template_variables=None, template=None, send_strategy=None, use_inbox_name=None, html=None, local_vars_configuration=None):  # noqa: E501
        """ReplyToEmailOptions - 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._body = None
        self._is_html = None
        self.__from = None
        self._reply_to = None
        self._custom_headers = None
        self._charset = None
        self._attachments = None
        self._template_variables = None
        self._template = None
        self._send_strategy = None
        self._use_inbox_name = None
        self._html = None
        self.discriminator = None

        self.body = body
        self.is_html = is_html
        self._from = _from
        self.reply_to = reply_to
        self.custom_headers = custom_headers
        self.charset = charset
        self.attachments = attachments
        self.template_variables = template_variables
        self.template = template
        self.send_strategy = send_strategy
        self.use_inbox_name = use_inbox_name
        if html is not None:
            self.html = html

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

        Body of the reply email you want to send  # noqa: E501

        :return: The body of this ReplyToEmailOptions.  # noqa: E501
        :rtype: str
        """
        return self._body

    @body.setter
    def body(self, body):
        """Sets the body of this ReplyToEmailOptions.

        Body of the reply email you want to send  # noqa: E501

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

        self._body = body

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

        Is the reply HTML  # noqa: E501

        :return: The is_html of this ReplyToEmailOptions.  # noqa: E501
        :rtype: bool
        """
        return self._is_html

    @is_html.setter
    def is_html(self, is_html):
        """Sets the is_html of this ReplyToEmailOptions.

        Is the reply HTML  # noqa: E501

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

        self._is_html = is_html

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

        The from header that should be used. Optional  # noqa: E501

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

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

        The from header that should be used. Optional  # noqa: E501

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

        self.__from = _from

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

        The replyTo header that should be used. Optional  # noqa: E501

        :return: The reply_to of this ReplyToEmailOptions.  # noqa: E501
        :rtype: str
        """
        return self._reply_to

    @reply_to.setter
    def reply_to(self, reply_to):
        """Sets the reply_to of this ReplyToEmailOptions.

        The replyTo header that should be used. Optional  # noqa: E501

        :param reply_to: The reply_to of this ReplyToEmailOptions.  # noqa: E501
        :type: str
        """

        self._reply_to = reply_to

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

        Optional custom headers  # noqa: E501

        :return: The custom_headers of this ReplyToEmailOptions.  # noqa: E501
        :rtype: dict(str, str)
        """
        return self._custom_headers

    @custom_headers.setter
    def custom_headers(self, custom_headers):
        """Sets the custom_headers of this ReplyToEmailOptions.

        Optional custom headers  # noqa: E501

        :param custom_headers: The custom_headers of this ReplyToEmailOptions.  # noqa: E501
        :type: dict(str, str)
        """

        self._custom_headers = custom_headers

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

        The charset that your message should be sent with. Optional. Default is UTF-8  # noqa: E501

        :return: The charset of this ReplyToEmailOptions.  # noqa: E501
        :rtype: str
        """
        return self._charset

    @charset.setter
    def charset(self, charset):
        """Sets the charset of this ReplyToEmailOptions.

        The charset that your message should be sent with. Optional. Default is UTF-8  # noqa: E501

        :param charset: The charset of this ReplyToEmailOptions.  # noqa: E501
        :type: str
        """

        self._charset = charset

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

        List of uploaded attachments to send with the reply. Optional.  # noqa: E501

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

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

        List of uploaded attachments to send with the reply. Optional.  # noqa: E501

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

        self._attachments = attachments

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

        Template variables if using a template  # noqa: E501

        :return: The template_variables of this ReplyToEmailOptions.  # noqa: E501
        :rtype: dict(str, object)
        """
        return self._template_variables

    @template_variables.setter
    def template_variables(self, template_variables):
        """Sets the template_variables of this ReplyToEmailOptions.

        Template variables if using a template  # noqa: E501

        :param template_variables: The template_variables of this ReplyToEmailOptions.  # noqa: E501
        :type: dict(str, object)
        """

        self._template_variables = template_variables

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

        Template ID to use instead of body. Will use template variable map to fill defined variable slots.  # noqa: E501

        :return: The template of this ReplyToEmailOptions.  # noqa: E501
        :rtype: str
        """
        return self._template

    @template.setter
    def template(self, template):
        """Sets the template of this ReplyToEmailOptions.

        Template ID to use instead of body. Will use template variable map to fill defined variable slots.  # noqa: E501

        :param template: The template of this ReplyToEmailOptions.  # noqa: E501
        :type: str
        """

        self._template = template

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

        How an email should be sent based on its recipients  # noqa: E501

        :return: The send_strategy of this ReplyToEmailOptions.  # noqa: E501
        :rtype: str
        """
        return self._send_strategy

    @send_strategy.setter
    def send_strategy(self, send_strategy):
        """Sets the send_strategy of this ReplyToEmailOptions.

        How an email should be sent based on its recipients  # noqa: E501

        :param send_strategy: The send_strategy of this ReplyToEmailOptions.  # noqa: E501
        :type: str
        """
        allowed_values = [None,"SINGLE_MESSAGE"]  # noqa: E501
        if self.local_vars_configuration.client_side_validation and send_strategy not in allowed_values:  # noqa: E501
            raise ValueError(
                "Invalid value for `send_strategy` ({0}), must be one of {1}"  # noqa: E501
                .format(send_strategy, allowed_values)
            )

        self._send_strategy = send_strategy

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

        Optionally use inbox name as display name for sender email address  # noqa: E501

        :return: The use_inbox_name of this ReplyToEmailOptions.  # noqa: E501
        :rtype: bool
        """
        return self._use_inbox_name

    @use_inbox_name.setter
    def use_inbox_name(self, use_inbox_name):
        """Sets the use_inbox_name of this ReplyToEmailOptions.

        Optionally use inbox name as display name for sender email address  # noqa: E501

        :param use_inbox_name: The use_inbox_name of this ReplyToEmailOptions.  # noqa: E501
        :type: bool
        """

        self._use_inbox_name = use_inbox_name

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


        :return: The html of this ReplyToEmailOptions.  # noqa: E501
        :rtype: bool
        """
        return self._html

    @html.setter
    def html(self, html):
        """Sets the html of this ReplyToEmailOptions.


        :param html: The html of this ReplyToEmailOptions.  # noqa: E501
        :type: bool
        """

        self._html = html

    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, ReplyToEmailOptions):
            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, ReplyToEmailOptions):
            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 ReplyToEmailOptions. # noqa: E501

List of uploaded attachments to send with the reply. Optional. # noqa: E501

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

Expand source code

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

    List of uploaded attachments to send with the reply. Optional.  # noqa: E501

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

prop body

Gets the body of this ReplyToEmailOptions. # noqa: E501

Body of the reply email you want to send # noqa: E501

:return: The body of this ReplyToEmailOptions. # noqa: E501 :rtype: str

Expand source code

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

    Body of the reply email you want to send  # noqa: E501

    :return: The body of this ReplyToEmailOptions.  # noqa: E501
    :rtype: str
    """
    return self._body

prop charset

Gets the charset of this ReplyToEmailOptions. # noqa: E501

The charset that your message should be sent with. Optional. Default is UTF-8 # noqa: E501

:return: The charset of this ReplyToEmailOptions. # noqa: E501 :rtype: str

Expand source code

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

    The charset that your message should be sent with. Optional. Default is UTF-8  # noqa: E501

    :return: The charset of this ReplyToEmailOptions.  # noqa: E501
    :rtype: str
    """
    return self._charset

prop custom_headers

Gets the custom_headers of this ReplyToEmailOptions. # noqa: E501

Optional custom headers # noqa: E501

:return: The custom_headers of this ReplyToEmailOptions. # noqa: E501 :rtype: dict(str, str)

Expand source code

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

    Optional custom headers  # noqa: E501

    :return: The custom_headers of this ReplyToEmailOptions.  # noqa: E501
    :rtype: dict(str, str)
    """
    return self._custom_headers

prop html

Gets the html of this ReplyToEmailOptions. # noqa: E501

:return: The html of this ReplyToEmailOptions. # noqa: E501 :rtype: bool

Expand source code

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


    :return: The html of this ReplyToEmailOptions.  # noqa: E501
    :rtype: bool
    """
    return self._html

prop is_html

Gets the is_html of this ReplyToEmailOptions. # noqa: E501

Is the reply HTML # noqa: E501

:return: The is_html of this ReplyToEmailOptions. # noqa: E501 :rtype: bool

Expand source code

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

    Is the reply HTML  # noqa: E501

    :return: The is_html of this ReplyToEmailOptions.  # noqa: E501
    :rtype: bool
    """
    return self._is_html

prop reply_to

Gets the reply_to of this ReplyToEmailOptions. # noqa: E501

The replyTo header that should be used. Optional # noqa: E501

:return: The reply_to of this ReplyToEmailOptions. # noqa: E501 :rtype: str

Expand source code

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

    The replyTo header that should be used. Optional  # noqa: E501

    :return: The reply_to of this ReplyToEmailOptions.  # noqa: E501
    :rtype: str
    """
    return self._reply_to

prop send_strategy

Gets the send_strategy of this ReplyToEmailOptions. # noqa: E501

How an email should be sent based on its recipients # noqa: E501

:return: The send_strategy of this ReplyToEmailOptions. # noqa: E501 :rtype: str

Expand source code

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

    How an email should be sent based on its recipients  # noqa: E501

    :return: The send_strategy of this ReplyToEmailOptions.  # noqa: E501
    :rtype: str
    """
    return self._send_strategy

prop template

Gets the template of this ReplyToEmailOptions. # noqa: E501

Template ID to use instead of body. Will use template variable map to fill defined variable slots. # noqa: E501

:return: The template of this ReplyToEmailOptions. # noqa: E501 :rtype: str

Expand source code

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

    Template ID to use instead of body. Will use template variable map to fill defined variable slots.  # noqa: E501

    :return: The template of this ReplyToEmailOptions.  # noqa: E501
    :rtype: str
    """
    return self._template

prop template_variables

Gets the template_variables of this ReplyToEmailOptions. # noqa: E501

Template variables if using a template # noqa: E501

:return: The template_variables of this ReplyToEmailOptions. # noqa: E501 :rtype: dict(str, object)

Expand source code

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

    Template variables if using a template  # noqa: E501

    :return: The template_variables of this ReplyToEmailOptions.  # noqa: E501
    :rtype: dict(str, object)
    """
    return self._template_variables

prop use_inbox_name

Gets the use_inbox_name of this ReplyToEmailOptions. # noqa: E501

Optionally use inbox name as display name for sender email address # noqa: E501

:return: The use_inbox_name of this ReplyToEmailOptions. # noqa: E501 :rtype: bool

Expand source code

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

    Optionally use inbox name as display name for sender email address  # noqa: E501

    :return: The use_inbox_name of this ReplyToEmailOptions.  # noqa: E501
    :rtype: bool
    """
    return self._use_inbox_name

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model