Module mailslurp_client.models.email_preview_html_dto

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 EmailPreviewHtmlDto (subject=None, html=None, link_behavior=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.

EmailPreviewHtmlDto - a model defined in OpenAPI

Expand source code

class EmailPreviewHtmlDto(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 = {
        'subject': 'str',
        'html': 'str',
        'link_behavior': 'str'
    }

    attribute_map = {
        'subject': 'subject',
        'html': 'html',
        'link_behavior': 'linkBehavior'
    }

    def __init__(self, subject=None, html=None, link_behavior=None, local_vars_configuration=None):  # noqa: E501
        """EmailPreviewHtmlDto - 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._subject = None
        self._html = None
        self._link_behavior = None
        self.discriminator = None

        self.subject = subject
        self.html = html
        self.link_behavior = link_behavior

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

        Email subject when available  # noqa: E501

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

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

        Email subject when available  # noqa: E501

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

        self._subject = subject

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

        Server-normalized preview HTML with active content removed  # noqa: E501

        :return: The html of this EmailPreviewHtmlDto.  # noqa: E501
        :rtype: str
        """
        return self._html

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

        Server-normalized preview HTML with active content removed  # noqa: E501

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

        self._html = html

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

        Controls navigation for links in hardened email HTML previews. Original email HTML endpoints are unaffected.  # noqa: E501

        :return: The link_behavior of this EmailPreviewHtmlDto.  # noqa: E501
        :rtype: str
        """
        return self._link_behavior

    @link_behavior.setter
    def link_behavior(self, link_behavior):
        """Sets the link_behavior of this EmailPreviewHtmlDto.

        Controls navigation for links in hardened email HTML previews. Original email HTML endpoints are unaffected.  # noqa: E501

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

        self._link_behavior = link_behavior

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop html

Gets the html of this EmailPreviewHtmlDto. # noqa: E501

Server-normalized preview HTML with active content removed # noqa: E501

:return: The html of this EmailPreviewHtmlDto. # noqa: E501 :rtype: str

Expand source code

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

    Server-normalized preview HTML with active content removed  # noqa: E501

    :return: The html of this EmailPreviewHtmlDto.  # noqa: E501
    :rtype: str
    """
    return self._html

prop link_behavior

Gets the link_behavior of this EmailPreviewHtmlDto. # noqa: E501

Controls navigation for links in hardened email HTML previews. Original email HTML endpoints are unaffected. # noqa: E501

:return: The link_behavior of this EmailPreviewHtmlDto. # noqa: E501 :rtype: str

Expand source code

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

    Controls navigation for links in hardened email HTML previews. Original email HTML endpoints are unaffected.  # noqa: E501

    :return: The link_behavior of this EmailPreviewHtmlDto.  # noqa: E501
    :rtype: str
    """
    return self._link_behavior

prop subject

Gets the subject of this EmailPreviewHtmlDto. # noqa: E501

Email subject when available # noqa: E501

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

Expand source code

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

    Email subject when available  # noqa: E501

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

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model