Module mailslurp_client.models.inline_object2

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 InlineObject2 (to=None, subject=None, email_address=None, success_message=None, spam_check=None, other_parameters=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.

InlineObject2 - a model defined in OpenAPI

Expand source code

class InlineObject2(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 = {
        'to': 'str',
        'subject': 'str',
        'email_address': 'str',
        'success_message': 'str',
        'spam_check': 'str',
        'other_parameters': 'str'
    }

    attribute_map = {
        'to': '_to',
        'subject': '_subject',
        'email_address': '_emailAddress',
        'success_message': '_successMessage',
        'spam_check': '_spamCheck',
        'other_parameters': 'otherParameters'
    }

    def __init__(self, to=None, subject=None, email_address=None, success_message=None, spam_check=None, other_parameters=None, local_vars_configuration=None):  # noqa: E501
        """InlineObject2 - 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._to = None
        self._subject = None
        self._email_address = None
        self._success_message = None
        self._spam_check = None
        self._other_parameters = None
        self.discriminator = None

        if to is not None:
            self.to = to
        if subject is not None:
            self.subject = subject
        if email_address is not None:
            self.email_address = email_address
        if success_message is not None:
            self.success_message = success_message
        if spam_check is not None:
            self.spam_check = spam_check
        if other_parameters is not None:
            self.other_parameters = other_parameters

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

        The email address that submitted form should be sent to.  # noqa: E501

        :return: The to of this InlineObject2.  # noqa: E501
        :rtype: str
        """
        return self._to

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

        The email address that submitted form should be sent to.  # noqa: E501

        :param to: The to of this InlineObject2.  # noqa: E501
        :type: str
        """

        self._to = to

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

        Optional subject of the email that will be sent.  # noqa: E501

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

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

        Optional subject of the email that will be sent.  # noqa: E501

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

        self._subject = subject

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

        Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later.  # noqa: E501

        :return: The email_address of this InlineObject2.  # noqa: E501
        :rtype: str
        """
        return self._email_address

    @email_address.setter
    def email_address(self, email_address):
        """Sets the email_address of this InlineObject2.

        Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later.  # noqa: E501

        :param email_address: The email_address of this InlineObject2.  # noqa: E501
        :type: str
        """

        self._email_address = email_address

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

        Optional success message to display if no _redirectTo present.  # noqa: E501

        :return: The success_message of this InlineObject2.  # noqa: E501
        :rtype: str
        """
        return self._success_message

    @success_message.setter
    def success_message(self, success_message):
        """Sets the success_message of this InlineObject2.

        Optional success message to display if no _redirectTo present.  # noqa: E501

        :param success_message: The success_message of this InlineObject2.  # noqa: E501
        :type: str
        """

        self._success_message = success_message

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

        Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored.  # noqa: E501

        :return: The spam_check of this InlineObject2.  # noqa: E501
        :rtype: str
        """
        return self._spam_check

    @spam_check.setter
    def spam_check(self, spam_check):
        """Sets the spam_check of this InlineObject2.

        Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored.  # noqa: E501

        :param spam_check: The spam_check of this InlineObject2.  # noqa: E501
        :type: str
        """

        self._spam_check = spam_check

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

        All other parameters or fields will be accepted and attached to the sent email. This includes files and any HTML form field with a name. These fields will become the body of the email that is sent.  # noqa: E501

        :return: The other_parameters of this InlineObject2.  # noqa: E501
        :rtype: str
        """
        return self._other_parameters

    @other_parameters.setter
    def other_parameters(self, other_parameters):
        """Sets the other_parameters of this InlineObject2.

        All other parameters or fields will be accepted and attached to the sent email. This includes files and any HTML form field with a name. These fields will become the body of the email that is sent.  # noqa: E501

        :param other_parameters: The other_parameters of this InlineObject2.  # noqa: E501
        :type: str
        """

        self._other_parameters = other_parameters

    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, InlineObject2):
            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, InlineObject2):
            return True

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop email_address

Gets the email_address of this InlineObject2. # noqa: E501

Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later. # noqa: E501

:return: The email_address of this InlineObject2. # noqa: E501 :rtype: str

Expand source code

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

    Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later.  # noqa: E501

    :return: The email_address of this InlineObject2.  # noqa: E501
    :rtype: str
    """
    return self._email_address

prop other_parameters

Gets the other_parameters of this InlineObject2. # noqa: E501

All other parameters or fields will be accepted and attached to the sent email. This includes files and any HTML form field with a name. These fields will become the body of the email that is sent. # noqa: E501

:return: The other_parameters of this InlineObject2. # noqa: E501 :rtype: str

Expand source code

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

    All other parameters or fields will be accepted and attached to the sent email. This includes files and any HTML form field with a name. These fields will become the body of the email that is sent.  # noqa: E501

    :return: The other_parameters of this InlineObject2.  # noqa: E501
    :rtype: str
    """
    return self._other_parameters

prop spam_check

Gets the spam_check of this InlineObject2. # noqa: E501

Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored. # noqa: E501

:return: The spam_check of this InlineObject2. # noqa: E501 :rtype: str

Expand source code

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

    Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored.  # noqa: E501

    :return: The spam_check of this InlineObject2.  # noqa: E501
    :rtype: str
    """
    return self._spam_check

prop subject

Gets the subject of this InlineObject2. # noqa: E501

Optional subject of the email that will be sent. # noqa: E501

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

Expand source code

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

    Optional subject of the email that will be sent.  # noqa: E501

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

prop success_message

Gets the success_message of this InlineObject2. # noqa: E501

Optional success message to display if no _redirectTo present. # noqa: E501

:return: The success_message of this InlineObject2. # noqa: E501 :rtype: str

Expand source code

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

    Optional success message to display if no _redirectTo present.  # noqa: E501

    :return: The success_message of this InlineObject2.  # noqa: E501
    :rtype: str
    """
    return self._success_message

prop to

Gets the to of this InlineObject2. # noqa: E501

The email address that submitted form should be sent to. # noqa: E501

:return: The to of this InlineObject2. # noqa: E501 :rtype: str

Expand source code

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

    The email address that submitted form should be sent to.  # noqa: E501

    :return: The to of this InlineObject2.  # noqa: E501
    :rtype: str
    """
    return self._to

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model