Module mailslurp_client.models.update_inbox_replier_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 UpdateInboxReplierOptions (inbox_id=None, name=None, field=None, match=None, reply_to=None, subject=None, charset=None, is_html=None, ignore_reply_to=None, body=None, template_id=None, template_variables=None, should=None, match_options=None, attachments=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.

UpdateInboxReplierOptions - a model defined in OpenAPI

Expand source code

class UpdateInboxReplierOptions(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 = {
        'inbox_id': 'str',
        'name': 'str',
        'field': 'str',
        'match': 'str',
        'reply_to': 'str',
        'subject': 'str',
        '_from': 'str',
        'charset': 'str',
        'is_html': 'bool',
        'ignore_reply_to': 'bool',
        'body': 'str',
        'template_id': 'str',
        'template_variables': 'dict(str, object)',
        'should': 'str',
        'match_options': 'InboxAutomationMatchOptions',
        'attachments': 'list[str]'
    }

    attribute_map = {
        'inbox_id': 'inboxId',
        'name': 'name',
        'field': 'field',
        'match': 'match',
        'reply_to': 'replyTo',
        'subject': 'subject',
        '_from': 'from',
        'charset': 'charset',
        'is_html': 'isHTML',
        'ignore_reply_to': 'ignoreReplyTo',
        'body': 'body',
        'template_id': 'templateId',
        'template_variables': 'templateVariables',
        'should': 'should',
        'match_options': 'matchOptions',
        'attachments': 'attachments'
    }

    def __init__(self, inbox_id=None, name=None, field=None, match=None, reply_to=None, subject=None, _from=None, charset=None, is_html=None, ignore_reply_to=None, body=None, template_id=None, template_variables=None, should=None, match_options=None, attachments=None, local_vars_configuration=None):  # noqa: E501
        """UpdateInboxReplierOptions - 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._inbox_id = None
        self._name = None
        self._field = None
        self._match = None
        self._reply_to = None
        self._subject = None
        self.__from = None
        self._charset = None
        self._is_html = None
        self._ignore_reply_to = None
        self._body = None
        self._template_id = None
        self._template_variables = None
        self._should = None
        self._match_options = None
        self._attachments = None
        self.discriminator = None

        self.inbox_id = inbox_id
        self.name = name
        self.field = field
        self.match = match
        self.reply_to = reply_to
        self.subject = subject
        self._from = _from
        self.charset = charset
        self.is_html = is_html
        self.ignore_reply_to = ignore_reply_to
        self.body = body
        self.template_id = template_id
        self.template_variables = template_variables
        self.should = should
        self.match_options = match_options
        self.attachments = attachments

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

        Inbox ID to attach replier to. Set null for a global replier.  # noqa: E501

        :return: The inbox_id of this UpdateInboxReplierOptions.  # noqa: E501
        :rtype: str
        """
        return self._inbox_id

    @inbox_id.setter
    def inbox_id(self, inbox_id):
        """Sets the inbox_id of this UpdateInboxReplierOptions.

        Inbox ID to attach replier to. Set null for a global replier.  # noqa: E501

        :param inbox_id: The inbox_id of this UpdateInboxReplierOptions.  # noqa: E501
        :type: str
        """

        self._inbox_id = inbox_id

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

        Name for replier  # noqa: E501

        :return: The name of this UpdateInboxReplierOptions.  # noqa: E501
        :rtype: str
        """
        return self._name

    @name.setter
    def name(self, name):
        """Sets the name of this UpdateInboxReplierOptions.

        Name for replier  # noqa: E501

        :param name: The name of this UpdateInboxReplierOptions.  # noqa: E501
        :type: str
        """

        self._name = name

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

        Field to match against to trigger inbox replier for inbound email  # noqa: E501

        :return: The field of this UpdateInboxReplierOptions.  # noqa: E501
        :rtype: str
        """
        return self._field

    @field.setter
    def field(self, field):
        """Sets the field of this UpdateInboxReplierOptions.

        Field to match against to trigger inbox replier for inbound email  # noqa: E501

        :param field: The field of this UpdateInboxReplierOptions.  # noqa: E501
        :type: str
        """
        allowed_values = [None,"RECIPIENTS", "SENDER", "SUBJECT", "ATTACHMENTS", "ATTACHMENT_FILENAME", "ATTACHMENT_TEXT"]  # noqa: E501
        if self.local_vars_configuration.client_side_validation and field not in allowed_values:  # noqa: E501
            raise ValueError(
                "Invalid value for `field` ({0}), must be one of {1}"  # noqa: E501
                .format(field, allowed_values)
            )

        self._field = field

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

        String or wildcard style match for field specified when evaluating reply rules  # noqa: E501

        :return: The match of this UpdateInboxReplierOptions.  # noqa: E501
        :rtype: str
        """
        return self._match

    @match.setter
    def match(self, match):
        """Sets the match of this UpdateInboxReplierOptions.

        String or wildcard style match for field specified when evaluating reply rules  # noqa: E501

        :param match: The match of this UpdateInboxReplierOptions.  # noqa: E501
        :type: str
        """

        self._match = match

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

        Reply-to email address when sending replying  # noqa: E501

        :return: The reply_to of this UpdateInboxReplierOptions.  # noqa: E501
        :rtype: str
        """
        return self._reply_to

    @reply_to.setter
    def reply_to(self, reply_to):
        """Sets the reply_to of this UpdateInboxReplierOptions.

        Reply-to email address when sending replying  # noqa: E501

        :param reply_to: The reply_to of this UpdateInboxReplierOptions.  # noqa: E501
        :type: str
        """

        self._reply_to = reply_to

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

        Subject override when replying to email  # noqa: E501

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

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

        Subject override when replying to email  # noqa: E501

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

        self._subject = subject

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

        Send email from address  # noqa: E501

        :return: The _from of this UpdateInboxReplierOptions.  # noqa: E501
        :rtype: str
        """
        return self.__from

    @_from.setter
    def _from(self, _from):
        """Sets the _from of this UpdateInboxReplierOptions.

        Send email from address  # noqa: E501

        :param _from: The _from of this UpdateInboxReplierOptions.  # noqa: E501
        :type: str
        """

        self.__from = _from

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

        Email reply charset  # noqa: E501

        :return: The charset of this UpdateInboxReplierOptions.  # noqa: E501
        :rtype: str
        """
        return self._charset

    @charset.setter
    def charset(self, charset):
        """Sets the charset of this UpdateInboxReplierOptions.

        Email reply charset  # noqa: E501

        :param charset: The charset of this UpdateInboxReplierOptions.  # noqa: E501
        :type: str
        """

        self._charset = charset

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

        Send HTML email  # noqa: E501

        :return: The is_html of this UpdateInboxReplierOptions.  # noqa: E501
        :rtype: bool
        """
        return self._is_html

    @is_html.setter
    def is_html(self, is_html):
        """Sets the is_html of this UpdateInboxReplierOptions.

        Send HTML email  # noqa: E501

        :param is_html: The is_html of this UpdateInboxReplierOptions.  # noqa: E501
        :type: bool
        """

        self._is_html = is_html

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

        Ignore sender replyTo when responding. Send directly to the sender if enabled.  # noqa: E501

        :return: The ignore_reply_to of this UpdateInboxReplierOptions.  # noqa: E501
        :rtype: bool
        """
        return self._ignore_reply_to

    @ignore_reply_to.setter
    def ignore_reply_to(self, ignore_reply_to):
        """Sets the ignore_reply_to of this UpdateInboxReplierOptions.

        Ignore sender replyTo when responding. Send directly to the sender if enabled.  # noqa: E501

        :param ignore_reply_to: The ignore_reply_to of this UpdateInboxReplierOptions.  # noqa: E501
        :type: bool
        """

        self._ignore_reply_to = ignore_reply_to

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

        Email body for reply  # noqa: E501

        :return: The body of this UpdateInboxReplierOptions.  # noqa: E501
        :rtype: str
        """
        return self._body

    @body.setter
    def body(self, body):
        """Sets the body of this UpdateInboxReplierOptions.

        Email body for reply  # noqa: E501

        :param body: The body of this UpdateInboxReplierOptions.  # noqa: E501
        :type: str
        """

        self._body = body

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

        ID of template to use when sending a reply  # noqa: E501

        :return: The template_id of this UpdateInboxReplierOptions.  # noqa: E501
        :rtype: str
        """
        return self._template_id

    @template_id.setter
    def template_id(self, template_id):
        """Sets the template_id of this UpdateInboxReplierOptions.

        ID of template to use when sending a reply  # noqa: E501

        :param template_id: The template_id of this UpdateInboxReplierOptions.  # noqa: E501
        :type: str
        """

        self._template_id = template_id

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

        Template variable values  # noqa: E501

        :return: The template_variables of this UpdateInboxReplierOptions.  # noqa: E501
        :rtype: dict(str, object)
        """
        return self._template_variables

    @template_variables.setter
    def template_variables(self, template_variables):
        """Sets the template_variables of this UpdateInboxReplierOptions.

        Template variable values  # noqa: E501

        :param template_variables: The template_variables of this UpdateInboxReplierOptions.  # noqa: E501
        :type: dict(str, object)
        """

        self._template_variables = template_variables

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

        Comparison mode for inbox automation matching.  # noqa: E501

        :return: The should of this UpdateInboxReplierOptions.  # noqa: E501
        :rtype: str
        """
        return self._should

    @should.setter
    def should(self, should):
        """Sets the should of this UpdateInboxReplierOptions.

        Comparison mode for inbox automation matching.  # noqa: E501

        :param should: The should of this UpdateInboxReplierOptions.  # noqa: E501
        :type: str
        """
        allowed_values = [None,"WILDCARD", "MATCH", "CONTAIN", "EQUAL"]  # noqa: E501
        if self.local_vars_configuration.client_side_validation and should not in allowed_values:  # noqa: E501
            raise ValueError(
                "Invalid value for `should` ({0}), must be one of {1}"  # noqa: E501
                .format(should, allowed_values)
            )

        self._should = should

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


        :return: The match_options of this UpdateInboxReplierOptions.  # noqa: E501
        :rtype: InboxAutomationMatchOptions
        """
        return self._match_options

    @match_options.setter
    def match_options(self, match_options):
        """Sets the match_options of this UpdateInboxReplierOptions.


        :param match_options: The match_options of this UpdateInboxReplierOptions.  # noqa: E501
        :type: InboxAutomationMatchOptions
        """

        self._match_options = match_options

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

        Optional attachment IDs to include with every automated reply  # noqa: E501

        :return: The attachments of this UpdateInboxReplierOptions.  # noqa: E501
        :rtype: list[str]
        """
        return self._attachments

    @attachments.setter
    def attachments(self, attachments):
        """Sets the attachments of this UpdateInboxReplierOptions.

        Optional attachment IDs to include with every automated reply  # noqa: E501

        :param attachments: The attachments of this UpdateInboxReplierOptions.  # noqa: E501
        :type: list[str]
        """

        self._attachments = attachments

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop attachments

Gets the attachments of this UpdateInboxReplierOptions. # noqa: E501

Optional attachment IDs to include with every automated reply # noqa: E501

:return: The attachments of this UpdateInboxReplierOptions. # noqa: E501 :rtype: list[str]

Expand source code

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

    Optional attachment IDs to include with every automated reply  # noqa: E501

    :return: The attachments of this UpdateInboxReplierOptions.  # noqa: E501
    :rtype: list[str]
    """
    return self._attachments

prop body

Gets the body of this UpdateInboxReplierOptions. # noqa: E501

Email body for reply # noqa: E501

:return: The body of this UpdateInboxReplierOptions. # noqa: E501 :rtype: str

Expand source code

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

    Email body for reply  # noqa: E501

    :return: The body of this UpdateInboxReplierOptions.  # noqa: E501
    :rtype: str
    """
    return self._body

prop charset

Gets the charset of this UpdateInboxReplierOptions. # noqa: E501

Email reply charset # noqa: E501

:return: The charset of this UpdateInboxReplierOptions. # noqa: E501 :rtype: str

Expand source code

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

    Email reply charset  # noqa: E501

    :return: The charset of this UpdateInboxReplierOptions.  # noqa: E501
    :rtype: str
    """
    return self._charset

prop field

Gets the field of this UpdateInboxReplierOptions. # noqa: E501

Field to match against to trigger inbox replier for inbound email # noqa: E501

:return: The field of this UpdateInboxReplierOptions. # noqa: E501 :rtype: str

Expand source code

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

    Field to match against to trigger inbox replier for inbound email  # noqa: E501

    :return: The field of this UpdateInboxReplierOptions.  # noqa: E501
    :rtype: str
    """
    return self._field

prop ignore_reply_to

Gets the ignore_reply_to of this UpdateInboxReplierOptions. # noqa: E501

Ignore sender replyTo when responding. Send directly to the sender if enabled. # noqa: E501

:return: The ignore_reply_to of this UpdateInboxReplierOptions. # noqa: E501 :rtype: bool

Expand source code

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

    Ignore sender replyTo when responding. Send directly to the sender if enabled.  # noqa: E501

    :return: The ignore_reply_to of this UpdateInboxReplierOptions.  # noqa: E501
    :rtype: bool
    """
    return self._ignore_reply_to

prop inbox_id

Gets the inbox_id of this UpdateInboxReplierOptions. # noqa: E501

Inbox ID to attach replier to. Set null for a global replier. # noqa: E501

:return: The inbox_id of this UpdateInboxReplierOptions. # noqa: E501 :rtype: str

Expand source code

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

    Inbox ID to attach replier to. Set null for a global replier.  # noqa: E501

    :return: The inbox_id of this UpdateInboxReplierOptions.  # noqa: E501
    :rtype: str
    """
    return self._inbox_id

prop is_html

Gets the is_html of this UpdateInboxReplierOptions. # noqa: E501

Send HTML email # noqa: E501

:return: The is_html of this UpdateInboxReplierOptions. # noqa: E501 :rtype: bool

Expand source code

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

    Send HTML email  # noqa: E501

    :return: The is_html of this UpdateInboxReplierOptions.  # noqa: E501
    :rtype: bool
    """
    return self._is_html

prop match

Gets the match of this UpdateInboxReplierOptions. # noqa: E501

String or wildcard style match for field specified when evaluating reply rules # noqa: E501

:return: The match of this UpdateInboxReplierOptions. # noqa: E501 :rtype: str

Expand source code

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

    String or wildcard style match for field specified when evaluating reply rules  # noqa: E501

    :return: The match of this UpdateInboxReplierOptions.  # noqa: E501
    :rtype: str
    """
    return self._match

prop match_options

Gets the match_options of this UpdateInboxReplierOptions. # noqa: E501

:return: The match_options of this UpdateInboxReplierOptions. # noqa: E501 :rtype: InboxAutomationMatchOptions

Expand source code

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


    :return: The match_options of this UpdateInboxReplierOptions.  # noqa: E501
    :rtype: InboxAutomationMatchOptions
    """
    return self._match_options

prop name

Gets the name of this UpdateInboxReplierOptions. # noqa: E501

Name for replier # noqa: E501

:return: The name of this UpdateInboxReplierOptions. # noqa: E501 :rtype: str

Expand source code

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

    Name for replier  # noqa: E501

    :return: The name of this UpdateInboxReplierOptions.  # noqa: E501
    :rtype: str
    """
    return self._name

prop reply_to

Gets the reply_to of this UpdateInboxReplierOptions. # noqa: E501

Reply-to email address when sending replying # noqa: E501

:return: The reply_to of this UpdateInboxReplierOptions. # noqa: E501 :rtype: str

Expand source code

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

    Reply-to email address when sending replying  # noqa: E501

    :return: The reply_to of this UpdateInboxReplierOptions.  # noqa: E501
    :rtype: str
    """
    return self._reply_to

prop should

Gets the should of this UpdateInboxReplierOptions. # noqa: E501

Comparison mode for inbox automation matching. # noqa: E501

:return: The should of this UpdateInboxReplierOptions. # noqa: E501 :rtype: str

Expand source code

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

    Comparison mode for inbox automation matching.  # noqa: E501

    :return: The should of this UpdateInboxReplierOptions.  # noqa: E501
    :rtype: str
    """
    return self._should

prop subject

Gets the subject of this UpdateInboxReplierOptions. # noqa: E501

Subject override when replying to email # noqa: E501

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

Expand source code

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

    Subject override when replying to email  # noqa: E501

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

prop template_id

Gets the template_id of this UpdateInboxReplierOptions. # noqa: E501

ID of template to use when sending a reply # noqa: E501

:return: The template_id of this UpdateInboxReplierOptions. # noqa: E501 :rtype: str

Expand source code

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

    ID of template to use when sending a reply  # noqa: E501

    :return: The template_id of this UpdateInboxReplierOptions.  # noqa: E501
    :rtype: str
    """
    return self._template_id

prop template_variables

Gets the template_variables of this UpdateInboxReplierOptions. # noqa: E501

Template variable values # noqa: E501

:return: The template_variables of this UpdateInboxReplierOptions. # noqa: E501 :rtype: dict(str, object)

Expand source code

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

    Template variable values  # noqa: E501

    :return: The template_variables of this UpdateInboxReplierOptions.  # noqa: E501
    :rtype: dict(str, object)
    """
    return self._template_variables

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model