Module mailslurp_client.models.create_public_spam_test_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 CreatePublicSpamTestOptions (from_email=None, sender_domain=None, requested_segment=None, address_format=None, captcha_token=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.

CreatePublicSpamTestOptions - a model defined in OpenAPI

Expand source code

class CreatePublicSpamTestOptions(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 = {
        'from_email': 'str',
        'sender_domain': 'str',
        'requested_segment': 'str',
        'address_format': 'str',
        'captcha_token': 'str'
    }

    attribute_map = {
        'from_email': 'fromEmail',
        'sender_domain': 'senderDomain',
        'requested_segment': 'requestedSegment',
        'address_format': 'addressFormat',
        'captcha_token': 'captchaToken'
    }

    def __init__(self, from_email=None, sender_domain=None, requested_segment=None, address_format=None, captcha_token=None, local_vars_configuration=None):  # noqa: E501
        """CreatePublicSpamTestOptions - 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._from_email = None
        self._sender_domain = None
        self._requested_segment = None
        self._address_format = None
        self._captcha_token = None
        self.discriminator = None

        self.from_email = from_email
        self.sender_domain = sender_domain
        self.requested_segment = requested_segment
        self.address_format = address_format
        self.captcha_token = captcha_token

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

        Optional sender email address. If provided, MailSlurp will also derive senderDomain for compatibility with inbox placement service versions that still expect it.  # noqa: E501

        :return: The from_email of this CreatePublicSpamTestOptions.  # noqa: E501
        :rtype: str
        """
        return self._from_email

    @from_email.setter
    def from_email(self, from_email):
        """Sets the from_email of this CreatePublicSpamTestOptions.

        Optional sender email address. If provided, MailSlurp will also derive senderDomain for compatibility with inbox placement service versions that still expect it.  # noqa: E501

        :param from_email: The from_email of this CreatePublicSpamTestOptions.  # noqa: E501
        :type: str
        """
        if (self.local_vars_configuration.client_side_validation and
                from_email is not None and len(from_email) > 320):
            raise ValueError("Invalid value for `from_email`, length must be less than or equal to `320`")  # noqa: E501
        if (self.local_vars_configuration.client_side_validation and
                from_email is not None and len(from_email) < 0):
            raise ValueError("Invalid value for `from_email`, length must be greater than or equal to `0`")  # noqa: E501

        self._from_email = from_email

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

        Optional sender domain. If omitted and fromEmail is provided, MailSlurp derives it automatically.  # noqa: E501

        :return: The sender_domain of this CreatePublicSpamTestOptions.  # noqa: E501
        :rtype: str
        """
        return self._sender_domain

    @sender_domain.setter
    def sender_domain(self, sender_domain):
        """Sets the sender_domain of this CreatePublicSpamTestOptions.

        Optional sender domain. If omitted and fromEmail is provided, MailSlurp derives it automatically.  # noqa: E501

        :param sender_domain: The sender_domain of this CreatePublicSpamTestOptions.  # noqa: E501
        :type: str
        """
        if (self.local_vars_configuration.client_side_validation and
                sender_domain is not None and len(sender_domain) > 320):
            raise ValueError("Invalid value for `sender_domain`, length must be less than or equal to `320`")  # noqa: E501
        if (self.local_vars_configuration.client_side_validation and
                sender_domain is not None and len(sender_domain) < 0):
            raise ValueError("Invalid value for `sender_domain`, length must be greater than or equal to `0`")  # noqa: E501

        self._sender_domain = sender_domain

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

        Requested seed cohort for the placement test.  # noqa: E501

        :return: The requested_segment of this CreatePublicSpamTestOptions.  # noqa: E501
        :rtype: str
        """
        return self._requested_segment

    @requested_segment.setter
    def requested_segment(self, requested_segment):
        """Sets the requested_segment of this CreatePublicSpamTestOptions.

        Requested seed cohort for the placement test.  # noqa: E501

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

        self._requested_segment = requested_segment

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

        Address export format for the returned seed addresses.  # noqa: E501

        :return: The address_format of this CreatePublicSpamTestOptions.  # noqa: E501
        :rtype: str
        """
        return self._address_format

    @address_format.setter
    def address_format(self, address_format):
        """Sets the address_format of this CreatePublicSpamTestOptions.

        Address export format for the returned seed addresses.  # noqa: E501

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

        self._address_format = address_format

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

        Optional captcha token when captcha protection is enabled.  # noqa: E501

        :return: The captcha_token of this CreatePublicSpamTestOptions.  # noqa: E501
        :rtype: str
        """
        return self._captcha_token

    @captcha_token.setter
    def captcha_token(self, captcha_token):
        """Sets the captcha_token of this CreatePublicSpamTestOptions.

        Optional captcha token when captcha protection is enabled.  # noqa: E501

        :param captcha_token: The captcha_token of this CreatePublicSpamTestOptions.  # noqa: E501
        :type: str
        """

        self._captcha_token = captcha_token

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop address_format

Gets the address_format of this CreatePublicSpamTestOptions. # noqa: E501

Address export format for the returned seed addresses. # noqa: E501

:return: The address_format of this CreatePublicSpamTestOptions. # noqa: E501 :rtype: str

Expand source code

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

    Address export format for the returned seed addresses.  # noqa: E501

    :return: The address_format of this CreatePublicSpamTestOptions.  # noqa: E501
    :rtype: str
    """
    return self._address_format

prop captcha_token

Gets the captcha_token of this CreatePublicSpamTestOptions. # noqa: E501

Optional captcha token when captcha protection is enabled. # noqa: E501

:return: The captcha_token of this CreatePublicSpamTestOptions. # noqa: E501 :rtype: str

Expand source code

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

    Optional captcha token when captcha protection is enabled.  # noqa: E501

    :return: The captcha_token of this CreatePublicSpamTestOptions.  # noqa: E501
    :rtype: str
    """
    return self._captcha_token

prop from_email

Gets the from_email of this CreatePublicSpamTestOptions. # noqa: E501

Optional sender email address. If provided, MailSlurp will also derive senderDomain for compatibility with inbox placement service versions that still expect it. # noqa: E501

:return: The from_email of this CreatePublicSpamTestOptions. # noqa: E501 :rtype: str

Expand source code

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

    Optional sender email address. If provided, MailSlurp will also derive senderDomain for compatibility with inbox placement service versions that still expect it.  # noqa: E501

    :return: The from_email of this CreatePublicSpamTestOptions.  # noqa: E501
    :rtype: str
    """
    return self._from_email

prop requested_segment

Gets the requested_segment of this CreatePublicSpamTestOptions. # noqa: E501

Requested seed cohort for the placement test. # noqa: E501

:return: The requested_segment of this CreatePublicSpamTestOptions. # noqa: E501 :rtype: str

Expand source code

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

    Requested seed cohort for the placement test.  # noqa: E501

    :return: The requested_segment of this CreatePublicSpamTestOptions.  # noqa: E501
    :rtype: str
    """
    return self._requested_segment

prop sender_domain

Gets the sender_domain of this CreatePublicSpamTestOptions. # noqa: E501

Optional sender domain. If omitted and fromEmail is provided, MailSlurp derives it automatically. # noqa: E501

:return: The sender_domain of this CreatePublicSpamTestOptions. # noqa: E501 :rtype: str

Expand source code

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

    Optional sender domain. If omitted and fromEmail is provided, MailSlurp derives it automatically.  # noqa: E501

    :return: The sender_domain of this CreatePublicSpamTestOptions.  # noqa: E501
    :rtype: str
    """
    return self._sender_domain

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model