Module mailslurp_client.models.check_email_blacklist_results

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 CheckEmailBlacklistResults (domain=None, requested_ip_address=None, requested_mx_host=None, status=None, listed=None, checked_ip_addresses=None, checked_zone_count=None, total_listings=None, warnings=None, errors=None, check_status=None, checked_domains=None, checked_at=None, evidence_version=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.

CheckEmailBlacklistResults - a model defined in OpenAPI

Expand source code

class CheckEmailBlacklistResults(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 = {
        'domain': 'str',
        'requested_ip_address': 'str',
        'requested_mx_host': 'str',
        'status': 'str',
        'listed': 'bool',
        'checked_ip_addresses': 'list[EmailBlacklistIpResult]',
        'checked_zone_count': 'int',
        'total_listings': 'int',
        'warnings': 'list[str]',
        'errors': 'list[str]',
        'check_status': 'str',
        'checked_domains': 'list[EmailBlacklistDomainResult]',
        'checked_at': 'datetime',
        'evidence_version': 'str'
    }

    attribute_map = {
        'domain': 'domain',
        'requested_ip_address': 'requestedIpAddress',
        'requested_mx_host': 'requestedMxHost',
        'status': 'status',
        'listed': 'listed',
        'checked_ip_addresses': 'checkedIpAddresses',
        'checked_zone_count': 'checkedZoneCount',
        'total_listings': 'totalListings',
        'warnings': 'warnings',
        'errors': 'errors',
        'check_status': 'checkStatus',
        'checked_domains': 'checkedDomains',
        'checked_at': 'checkedAt',
        'evidence_version': 'evidenceVersion'
    }

    def __init__(self, domain=None, requested_ip_address=None, requested_mx_host=None, status=None, listed=None, checked_ip_addresses=None, checked_zone_count=None, total_listings=None, warnings=None, errors=None, check_status=None, checked_domains=None, checked_at=None, evidence_version=None, local_vars_configuration=None):  # noqa: E501
        """CheckEmailBlacklistResults - 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._domain = None
        self._requested_ip_address = None
        self._requested_mx_host = None
        self._status = None
        self._listed = None
        self._checked_ip_addresses = None
        self._checked_zone_count = None
        self._total_listings = None
        self._warnings = None
        self._errors = None
        self._check_status = None
        self._checked_domains = None
        self._checked_at = None
        self._evidence_version = None
        self.discriminator = None

        self.domain = domain
        self.requested_ip_address = requested_ip_address
        self.requested_mx_host = requested_mx_host
        self.status = status
        self.listed = listed
        self.checked_ip_addresses = checked_ip_addresses
        self.checked_zone_count = checked_zone_count
        self.total_listings = total_listings
        self.warnings = warnings
        self.errors = errors
        self.check_status = check_status
        self.checked_domains = checked_domains
        self.checked_at = checked_at
        self.evidence_version = evidence_version

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


        :return: The domain of this CheckEmailBlacklistResults.  # noqa: E501
        :rtype: str
        """
        return self._domain

    @domain.setter
    def domain(self, domain):
        """Sets the domain of this CheckEmailBlacklistResults.


        :param domain: The domain of this CheckEmailBlacklistResults.  # noqa: E501
        :type: str
        """

        self._domain = domain

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


        :return: The requested_ip_address of this CheckEmailBlacklistResults.  # noqa: E501
        :rtype: str
        """
        return self._requested_ip_address

    @requested_ip_address.setter
    def requested_ip_address(self, requested_ip_address):
        """Sets the requested_ip_address of this CheckEmailBlacklistResults.


        :param requested_ip_address: The requested_ip_address of this CheckEmailBlacklistResults.  # noqa: E501
        :type: str
        """

        self._requested_ip_address = requested_ip_address

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


        :return: The requested_mx_host of this CheckEmailBlacklistResults.  # noqa: E501
        :rtype: str
        """
        return self._requested_mx_host

    @requested_mx_host.setter
    def requested_mx_host(self, requested_mx_host):
        """Sets the requested_mx_host of this CheckEmailBlacklistResults.


        :param requested_mx_host: The requested_mx_host of this CheckEmailBlacklistResults.  # noqa: E501
        :type: str
        """

        self._requested_mx_host = requested_mx_host

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


        :return: The status of this CheckEmailBlacklistResults.  # noqa: E501
        :rtype: str
        """
        return self._status

    @status.setter
    def status(self, status):
        """Sets the status of this CheckEmailBlacklistResults.


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

        self._status = status

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


        :return: The listed of this CheckEmailBlacklistResults.  # noqa: E501
        :rtype: bool
        """
        return self._listed

    @listed.setter
    def listed(self, listed):
        """Sets the listed of this CheckEmailBlacklistResults.


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

        self._listed = listed

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


        :return: The checked_ip_addresses of this CheckEmailBlacklistResults.  # noqa: E501
        :rtype: list[EmailBlacklistIpResult]
        """
        return self._checked_ip_addresses

    @checked_ip_addresses.setter
    def checked_ip_addresses(self, checked_ip_addresses):
        """Sets the checked_ip_addresses of this CheckEmailBlacklistResults.


        :param checked_ip_addresses: The checked_ip_addresses of this CheckEmailBlacklistResults.  # noqa: E501
        :type: list[EmailBlacklistIpResult]
        """
        if self.local_vars_configuration.client_side_validation and checked_ip_addresses is None:  # noqa: E501
            raise ValueError("Invalid value for `checked_ip_addresses`, must not be `None`")  # noqa: E501

        self._checked_ip_addresses = checked_ip_addresses

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


        :return: The checked_zone_count of this CheckEmailBlacklistResults.  # noqa: E501
        :rtype: int
        """
        return self._checked_zone_count

    @checked_zone_count.setter
    def checked_zone_count(self, checked_zone_count):
        """Sets the checked_zone_count of this CheckEmailBlacklistResults.


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

        self._checked_zone_count = checked_zone_count

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


        :return: The total_listings of this CheckEmailBlacklistResults.  # noqa: E501
        :rtype: int
        """
        return self._total_listings

    @total_listings.setter
    def total_listings(self, total_listings):
        """Sets the total_listings of this CheckEmailBlacklistResults.


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

        self._total_listings = total_listings

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


        :return: The warnings of this CheckEmailBlacklistResults.  # noqa: E501
        :rtype: list[str]
        """
        return self._warnings

    @warnings.setter
    def warnings(self, warnings):
        """Sets the warnings of this CheckEmailBlacklistResults.


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

        self._warnings = warnings

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


        :return: The errors of this CheckEmailBlacklistResults.  # noqa: E501
        :rtype: list[str]
        """
        return self._errors

    @errors.setter
    def errors(self, errors):
        """Sets the errors of this CheckEmailBlacklistResults.


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

        self._errors = errors

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


        :return: The check_status of this CheckEmailBlacklistResults.  # noqa: E501
        :rtype: str
        """
        return self._check_status

    @check_status.setter
    def check_status(self, check_status):
        """Sets the check_status of this CheckEmailBlacklistResults.


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

        self._check_status = check_status

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


        :return: The checked_domains of this CheckEmailBlacklistResults.  # noqa: E501
        :rtype: list[EmailBlacklistDomainResult]
        """
        return self._checked_domains

    @checked_domains.setter
    def checked_domains(self, checked_domains):
        """Sets the checked_domains of this CheckEmailBlacklistResults.


        :param checked_domains: The checked_domains of this CheckEmailBlacklistResults.  # noqa: E501
        :type: list[EmailBlacklistDomainResult]
        """
        if self.local_vars_configuration.client_side_validation and checked_domains is None:  # noqa: E501
            raise ValueError("Invalid value for `checked_domains`, must not be `None`")  # noqa: E501

        self._checked_domains = checked_domains

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


        :return: The checked_at of this CheckEmailBlacklistResults.  # noqa: E501
        :rtype: datetime
        """
        return self._checked_at

    @checked_at.setter
    def checked_at(self, checked_at):
        """Sets the checked_at of this CheckEmailBlacklistResults.


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

        self._checked_at = checked_at

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


        :return: The evidence_version of this CheckEmailBlacklistResults.  # noqa: E501
        :rtype: str
        """
        return self._evidence_version

    @evidence_version.setter
    def evidence_version(self, evidence_version):
        """Sets the evidence_version of this CheckEmailBlacklistResults.


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

        self._evidence_version = evidence_version

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop check_status

Gets the check_status of this CheckEmailBlacklistResults. # noqa: E501

:return: The check_status of this CheckEmailBlacklistResults. # noqa: E501 :rtype: str

Expand source code

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


    :return: The check_status of this CheckEmailBlacklistResults.  # noqa: E501
    :rtype: str
    """
    return self._check_status

prop checked_at

Gets the checked_at of this CheckEmailBlacklistResults. # noqa: E501

:return: The checked_at of this CheckEmailBlacklistResults. # noqa: E501 :rtype: datetime

Expand source code

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


    :return: The checked_at of this CheckEmailBlacklistResults.  # noqa: E501
    :rtype: datetime
    """
    return self._checked_at

prop checked_domains

Gets the checked_domains of this CheckEmailBlacklistResults. # noqa: E501

:return: The checked_domains of this CheckEmailBlacklistResults. # noqa: E501 :rtype: list[EmailBlacklistDomainResult]

Expand source code

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


    :return: The checked_domains of this CheckEmailBlacklistResults.  # noqa: E501
    :rtype: list[EmailBlacklistDomainResult]
    """
    return self._checked_domains

prop checked_ip_addresses

Gets the checked_ip_addresses of this CheckEmailBlacklistResults. # noqa: E501

:return: The checked_ip_addresses of this CheckEmailBlacklistResults. # noqa: E501 :rtype: list[EmailBlacklistIpResult]

Expand source code

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


    :return: The checked_ip_addresses of this CheckEmailBlacklistResults.  # noqa: E501
    :rtype: list[EmailBlacklistIpResult]
    """
    return self._checked_ip_addresses

prop checked_zone_count

Gets the checked_zone_count of this CheckEmailBlacklistResults. # noqa: E501

:return: The checked_zone_count of this CheckEmailBlacklistResults. # noqa: E501 :rtype: int

Expand source code

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


    :return: The checked_zone_count of this CheckEmailBlacklistResults.  # noqa: E501
    :rtype: int
    """
    return self._checked_zone_count

prop domain

Gets the domain of this CheckEmailBlacklistResults. # noqa: E501

:return: The domain of this CheckEmailBlacklistResults. # noqa: E501 :rtype: str

Expand source code

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


    :return: The domain of this CheckEmailBlacklistResults.  # noqa: E501
    :rtype: str
    """
    return self._domain

prop errors

Gets the errors of this CheckEmailBlacklistResults. # noqa: E501

:return: The errors of this CheckEmailBlacklistResults. # noqa: E501 :rtype: list[str]

Expand source code

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


    :return: The errors of this CheckEmailBlacklistResults.  # noqa: E501
    :rtype: list[str]
    """
    return self._errors

prop evidence_version

Gets the evidence_version of this CheckEmailBlacklistResults. # noqa: E501

:return: The evidence_version of this CheckEmailBlacklistResults. # noqa: E501 :rtype: str

Expand source code

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


    :return: The evidence_version of this CheckEmailBlacklistResults.  # noqa: E501
    :rtype: str
    """
    return self._evidence_version

prop listed

Gets the listed of this CheckEmailBlacklistResults. # noqa: E501

:return: The listed of this CheckEmailBlacklistResults. # noqa: E501 :rtype: bool

Expand source code

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


    :return: The listed of this CheckEmailBlacklistResults.  # noqa: E501
    :rtype: bool
    """
    return self._listed

prop requested_ip_address

Gets the requested_ip_address of this CheckEmailBlacklistResults. # noqa: E501

:return: The requested_ip_address of this CheckEmailBlacklistResults. # noqa: E501 :rtype: str

Expand source code

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


    :return: The requested_ip_address of this CheckEmailBlacklistResults.  # noqa: E501
    :rtype: str
    """
    return self._requested_ip_address

prop requested_mx_host

Gets the requested_mx_host of this CheckEmailBlacklistResults. # noqa: E501

:return: The requested_mx_host of this CheckEmailBlacklistResults. # noqa: E501 :rtype: str

Expand source code

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


    :return: The requested_mx_host of this CheckEmailBlacklistResults.  # noqa: E501
    :rtype: str
    """
    return self._requested_mx_host

prop status

Gets the status of this CheckEmailBlacklistResults. # noqa: E501

:return: The status of this CheckEmailBlacklistResults. # noqa: E501 :rtype: str

Expand source code

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


    :return: The status of this CheckEmailBlacklistResults.  # noqa: E501
    :rtype: str
    """
    return self._status

prop total_listings

Gets the total_listings of this CheckEmailBlacklistResults. # noqa: E501

:return: The total_listings of this CheckEmailBlacklistResults. # noqa: E501 :rtype: int

Expand source code

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


    :return: The total_listings of this CheckEmailBlacklistResults.  # noqa: E501
    :rtype: int
    """
    return self._total_listings

prop warnings

Gets the warnings of this CheckEmailBlacklistResults. # noqa: E501

:return: The warnings of this CheckEmailBlacklistResults. # noqa: E501 :rtype: list[str]

Expand source code

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


    :return: The warnings of this CheckEmailBlacklistResults.  # noqa: E501
    :rtype: list[str]
    """
    return self._warnings

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model