Module mailslurp_client.models.check_campaign_probe_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 CheckCampaignProbeOptions (from_address=None, subject=None, recipient=None, message_id=None, html_body=None, text_body=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.

CheckCampaignProbeOptions - a model defined in OpenAPI

Expand source code

class CheckCampaignProbeOptions(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_address': 'str',
        'subject': 'str',
        'recipient': 'str',
        'message_id': 'str',
        'html_body': 'str',
        'text_body': 'str',
        'captcha_token': 'str'
    }

    attribute_map = {
        'from_address': 'fromAddress',
        'subject': 'subject',
        'recipient': 'recipient',
        'message_id': 'messageId',
        'html_body': 'htmlBody',
        'text_body': 'textBody',
        'captcha_token': 'captchaToken'
    }

    def __init__(self, from_address=None, subject=None, recipient=None, message_id=None, html_body=None, text_body=None, captcha_token=None, local_vars_configuration=None):  # noqa: E501
        """CheckCampaignProbeOptions - 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_address = None
        self._subject = None
        self._recipient = None
        self._message_id = None
        self._html_body = None
        self._text_body = None
        self._captcha_token = None
        self.discriminator = None

        self.from_address = from_address
        self.subject = subject
        self.recipient = recipient
        self.message_id = message_id
        self.html_body = html_body
        self.text_body = text_body
        self.captcha_token = captcha_token

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

        Optional sender email address  # noqa: E501

        :return: The from_address of this CheckCampaignProbeOptions.  # noqa: E501
        :rtype: str
        """
        return self._from_address

    @from_address.setter
    def from_address(self, from_address):
        """Sets the from_address of this CheckCampaignProbeOptions.

        Optional sender email address  # noqa: E501

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

        self._from_address = from_address

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

        Optional message subject  # noqa: E501

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

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

        Optional message subject  # noqa: E501

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

        self._subject = subject

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

        Optional recipient email address for context  # noqa: E501

        :return: The recipient of this CheckCampaignProbeOptions.  # noqa: E501
        :rtype: str
        """
        return self._recipient

    @recipient.setter
    def recipient(self, recipient):
        """Sets the recipient of this CheckCampaignProbeOptions.

        Optional recipient email address for context  # noqa: E501

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

        self._recipient = recipient

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

        Optional caller supplied message id  # noqa: E501

        :return: The message_id of this CheckCampaignProbeOptions.  # noqa: E501
        :rtype: str
        """
        return self._message_id

    @message_id.setter
    def message_id(self, message_id):
        """Sets the message_id of this CheckCampaignProbeOptions.

        Optional caller supplied message id  # noqa: E501

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

        self._message_id = message_id

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

        HTML body content to analyze  # noqa: E501

        :return: The html_body of this CheckCampaignProbeOptions.  # noqa: E501
        :rtype: str
        """
        return self._html_body

    @html_body.setter
    def html_body(self, html_body):
        """Sets the html_body of this CheckCampaignProbeOptions.

        HTML body content to analyze  # noqa: E501

        :param html_body: The html_body of this CheckCampaignProbeOptions.  # noqa: E501
        :type: str
        """

        self._html_body = html_body

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

        Text body content to analyze when HTML is absent  # noqa: E501

        :return: The text_body of this CheckCampaignProbeOptions.  # noqa: E501
        :rtype: str
        """
        return self._text_body

    @text_body.setter
    def text_body(self, text_body):
        """Sets the text_body of this CheckCampaignProbeOptions.

        Text body content to analyze when HTML is absent  # noqa: E501

        :param text_body: The text_body of this CheckCampaignProbeOptions.  # noqa: E501
        :type: str
        """

        self._text_body = text_body

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

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

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

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

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

        :param captcha_token: The captcha_token of this CheckCampaignProbeOptions.  # 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, CheckCampaignProbeOptions):
            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, CheckCampaignProbeOptions):
            return True

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop captcha_token

Gets the captcha_token of this CheckCampaignProbeOptions. # noqa: E501

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

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

Expand source code

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

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

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

prop from_address

Gets the from_address of this CheckCampaignProbeOptions. # noqa: E501

Optional sender email address # noqa: E501

:return: The from_address of this CheckCampaignProbeOptions. # noqa: E501 :rtype: str

Expand source code

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

    Optional sender email address  # noqa: E501

    :return: The from_address of this CheckCampaignProbeOptions.  # noqa: E501
    :rtype: str
    """
    return self._from_address

prop html_body

Gets the html_body of this CheckCampaignProbeOptions. # noqa: E501

HTML body content to analyze # noqa: E501

:return: The html_body of this CheckCampaignProbeOptions. # noqa: E501 :rtype: str

Expand source code

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

    HTML body content to analyze  # noqa: E501

    :return: The html_body of this CheckCampaignProbeOptions.  # noqa: E501
    :rtype: str
    """
    return self._html_body

prop message_id

Gets the message_id of this CheckCampaignProbeOptions. # noqa: E501

Optional caller supplied message id # noqa: E501

:return: The message_id of this CheckCampaignProbeOptions. # noqa: E501 :rtype: str

Expand source code

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

    Optional caller supplied message id  # noqa: E501

    :return: The message_id of this CheckCampaignProbeOptions.  # noqa: E501
    :rtype: str
    """
    return self._message_id

prop recipient

Gets the recipient of this CheckCampaignProbeOptions. # noqa: E501

Optional recipient email address for context # noqa: E501

:return: The recipient of this CheckCampaignProbeOptions. # noqa: E501 :rtype: str

Expand source code

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

    Optional recipient email address for context  # noqa: E501

    :return: The recipient of this CheckCampaignProbeOptions.  # noqa: E501
    :rtype: str
    """
    return self._recipient

prop subject

Gets the subject of this CheckCampaignProbeOptions. # noqa: E501

Optional message subject # noqa: E501

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

Expand source code

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

    Optional message subject  # noqa: E501

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

prop text_body

Gets the text_body of this CheckCampaignProbeOptions. # noqa: E501

Text body content to analyze when HTML is absent # noqa: E501

:return: The text_body of this CheckCampaignProbeOptions. # noqa: E501 :rtype: str

Expand source code

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

    Text body content to analyze when HTML is absent  # noqa: E501

    :return: The text_body of this CheckCampaignProbeOptions.  # noqa: E501
    :rtype: str
    """
    return self._text_body

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model