Module mailslurp_client.models.create_inbox_ruleset_options
MailSlurp API
MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. 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
Expand source code
# coding: utf-8
"""
MailSlurp API
MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository # noqa: E501
The version of the OpenAPI document: 6.5.2
Contact: contact@mailslurp.dev
Generated by: https://openapi-generator.tech
"""
import pprint
import re # noqa: F401
import six
from mailslurp_client.configuration import Configuration
class CreateInboxRulesetOptions(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 = {
'scope': 'str',
'action': 'str',
'target': 'str'
}
attribute_map = {
'scope': 'scope',
'action': 'action',
'target': 'target'
}
def __init__(self, scope=None, action=None, target=None, local_vars_configuration=None): # noqa: E501
"""CreateInboxRulesetOptions - 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._scope = None
self._action = None
self._target = None
self.discriminator = None
self.scope = scope
self.action = action
self.target = target
@property
def scope(self):
"""Gets the scope of this CreateInboxRulesetOptions. # noqa: E501
What type of emails actions to apply ruleset to. Either `SENDING_EMAILS` or `RECEIVING_EMAILS` will apply action and target to any sending or receiving of emails respectively. # noqa: E501
:return: The scope of this CreateInboxRulesetOptions. # noqa: E501
:rtype: str
"""
return self._scope
@scope.setter
def scope(self, scope):
"""Sets the scope of this CreateInboxRulesetOptions.
What type of emails actions to apply ruleset to. Either `SENDING_EMAILS` or `RECEIVING_EMAILS` will apply action and target to any sending or receiving of emails respectively. # noqa: E501
:param scope: The scope of this CreateInboxRulesetOptions. # noqa: E501
:type: str
"""
if self.local_vars_configuration.client_side_validation and scope is None: # noqa: E501
raise ValueError("Invalid value for `scope`, must not be `None`") # noqa: E501
allowed_values = ["RECEIVING_EMAILS", "SENDING_EMAILS"] # noqa: E501
if self.local_vars_configuration.client_side_validation and scope not in allowed_values: # noqa: E501
raise ValueError(
"Invalid value for `scope` ({0}), must be one of {1}" # noqa: E501
.format(scope, allowed_values)
)
self._scope = scope
@property
def action(self):
"""Gets the action of this CreateInboxRulesetOptions. # noqa: E501
Action to be taken when the ruleset matches an email for the given scope. For example: `BLOCK` action with target `*` and scope `SENDING_EMAILS` blocks sending to all recipients. Note `ALLOW` takes precedent over `BLOCK`. `FILTER_REMOVE` is like block but will remove offending email addresses during a send or receive event instead of blocking the action. # noqa: E501
:return: The action of this CreateInboxRulesetOptions. # noqa: E501
:rtype: str
"""
return self._action
@action.setter
def action(self, action):
"""Sets the action of this CreateInboxRulesetOptions.
Action to be taken when the ruleset matches an email for the given scope. For example: `BLOCK` action with target `*` and scope `SENDING_EMAILS` blocks sending to all recipients. Note `ALLOW` takes precedent over `BLOCK`. `FILTER_REMOVE` is like block but will remove offending email addresses during a send or receive event instead of blocking the action. # noqa: E501
:param action: The action of this CreateInboxRulesetOptions. # noqa: E501
:type: str
"""
if self.local_vars_configuration.client_side_validation and action is None: # noqa: E501
raise ValueError("Invalid value for `action`, must not be `None`") # noqa: E501
allowed_values = ["BLOCK", "ALLOW", "FILTER_REMOVE"] # noqa: E501
if self.local_vars_configuration.client_side_validation and action not in allowed_values: # noqa: E501
raise ValueError(
"Invalid value for `action` ({0}), must be one of {1}" # noqa: E501
.format(action, allowed_values)
)
self._action = action
@property
def target(self):
"""Gets the target of this CreateInboxRulesetOptions. # noqa: E501
Target to match emails with. Can be a wild-card type pattern or a valid email address. For instance `*@gmail.com` matches all gmail addresses while `test@gmail.com` matches one address exactly. The target is applied to every recipient field email address when `SENDING_EMAILS` is the scope and is applied to sender of email when `RECEIVING_EMAILS`. # noqa: E501
:return: The target of this CreateInboxRulesetOptions. # noqa: E501
:rtype: str
"""
return self._target
@target.setter
def target(self, target):
"""Sets the target of this CreateInboxRulesetOptions.
Target to match emails with. Can be a wild-card type pattern or a valid email address. For instance `*@gmail.com` matches all gmail addresses while `test@gmail.com` matches one address exactly. The target is applied to every recipient field email address when `SENDING_EMAILS` is the scope and is applied to sender of email when `RECEIVING_EMAILS`. # noqa: E501
:param target: The target of this CreateInboxRulesetOptions. # noqa: E501
:type: str
"""
if self.local_vars_configuration.client_side_validation and target is None: # noqa: E501
raise ValueError("Invalid value for `target`, must not be `None`") # noqa: E501
self._target = target
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, CreateInboxRulesetOptions):
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, CreateInboxRulesetOptions):
return True
return self.to_dict() != other.to_dict()Classes
class CreateInboxRulesetOptions (scope=None, action=None, target=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.
CreateInboxRulesetOptions - a model defined in OpenAPI
Expand source code
class CreateInboxRulesetOptions(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 = { 'scope': 'str', 'action': 'str', 'target': 'str' } attribute_map = { 'scope': 'scope', 'action': 'action', 'target': 'target' } def __init__(self, scope=None, action=None, target=None, local_vars_configuration=None): # noqa: E501 """CreateInboxRulesetOptions - 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._scope = None self._action = None self._target = None self.discriminator = None self.scope = scope self.action = action self.target = target @property def scope(self): """Gets the scope of this CreateInboxRulesetOptions. # noqa: E501 What type of emails actions to apply ruleset to. Either `SENDING_EMAILS` or `RECEIVING_EMAILS` will apply action and target to any sending or receiving of emails respectively. # noqa: E501 :return: The scope of this CreateInboxRulesetOptions. # noqa: E501 :rtype: str """ return self._scope @scope.setter def scope(self, scope): """Sets the scope of this CreateInboxRulesetOptions. What type of emails actions to apply ruleset to. Either `SENDING_EMAILS` or `RECEIVING_EMAILS` will apply action and target to any sending or receiving of emails respectively. # noqa: E501 :param scope: The scope of this CreateInboxRulesetOptions. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and scope is None: # noqa: E501 raise ValueError("Invalid value for `scope`, must not be `None`") # noqa: E501 allowed_values = ["RECEIVING_EMAILS", "SENDING_EMAILS"] # noqa: E501 if self.local_vars_configuration.client_side_validation and scope not in allowed_values: # noqa: E501 raise ValueError( "Invalid value for `scope` ({0}), must be one of {1}" # noqa: E501 .format(scope, allowed_values) ) self._scope = scope @property def action(self): """Gets the action of this CreateInboxRulesetOptions. # noqa: E501 Action to be taken when the ruleset matches an email for the given scope. For example: `BLOCK` action with target `*` and scope `SENDING_EMAILS` blocks sending to all recipients. Note `ALLOW` takes precedent over `BLOCK`. `FILTER_REMOVE` is like block but will remove offending email addresses during a send or receive event instead of blocking the action. # noqa: E501 :return: The action of this CreateInboxRulesetOptions. # noqa: E501 :rtype: str """ return self._action @action.setter def action(self, action): """Sets the action of this CreateInboxRulesetOptions. Action to be taken when the ruleset matches an email for the given scope. For example: `BLOCK` action with target `*` and scope `SENDING_EMAILS` blocks sending to all recipients. Note `ALLOW` takes precedent over `BLOCK`. `FILTER_REMOVE` is like block but will remove offending email addresses during a send or receive event instead of blocking the action. # noqa: E501 :param action: The action of this CreateInboxRulesetOptions. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and action is None: # noqa: E501 raise ValueError("Invalid value for `action`, must not be `None`") # noqa: E501 allowed_values = ["BLOCK", "ALLOW", "FILTER_REMOVE"] # noqa: E501 if self.local_vars_configuration.client_side_validation and action not in allowed_values: # noqa: E501 raise ValueError( "Invalid value for `action` ({0}), must be one of {1}" # noqa: E501 .format(action, allowed_values) ) self._action = action @property def target(self): """Gets the target of this CreateInboxRulesetOptions. # noqa: E501 Target to match emails with. Can be a wild-card type pattern or a valid email address. For instance `*@gmail.com` matches all gmail addresses while `test@gmail.com` matches one address exactly. The target is applied to every recipient field email address when `SENDING_EMAILS` is the scope and is applied to sender of email when `RECEIVING_EMAILS`. # noqa: E501 :return: The target of this CreateInboxRulesetOptions. # noqa: E501 :rtype: str """ return self._target @target.setter def target(self, target): """Sets the target of this CreateInboxRulesetOptions. Target to match emails with. Can be a wild-card type pattern or a valid email address. For instance `*@gmail.com` matches all gmail addresses while `test@gmail.com` matches one address exactly. The target is applied to every recipient field email address when `SENDING_EMAILS` is the scope and is applied to sender of email when `RECEIVING_EMAILS`. # noqa: E501 :param target: The target of this CreateInboxRulesetOptions. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and target is None: # noqa: E501 raise ValueError("Invalid value for `target`, must not be `None`") # noqa: E501 self._target = target 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, CreateInboxRulesetOptions): 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, CreateInboxRulesetOptions): return True return self.to_dict() != other.to_dict()Class variables
var attribute_mapvar openapi_types
Instance variables
var action-
Gets the action of this CreateInboxRulesetOptions. # noqa: E501
Action to be taken when the ruleset matches an email for the given scope. For example:
BLOCKaction with target*and scopeSENDING_EMAILSblocks sending to all recipients. NoteALLOWtakes precedent overBLOCK.FILTER_REMOVEis like block but will remove offending email addresses during a send or receive event instead of blocking the action. # noqa: E501:return: The action of this CreateInboxRulesetOptions. # noqa: E501 :rtype: str
Expand source code
@property def action(self): """Gets the action of this CreateInboxRulesetOptions. # noqa: E501 Action to be taken when the ruleset matches an email for the given scope. For example: `BLOCK` action with target `*` and scope `SENDING_EMAILS` blocks sending to all recipients. Note `ALLOW` takes precedent over `BLOCK`. `FILTER_REMOVE` is like block but will remove offending email addresses during a send or receive event instead of blocking the action. # noqa: E501 :return: The action of this CreateInboxRulesetOptions. # noqa: E501 :rtype: str """ return self._action var scope-
Gets the scope of this CreateInboxRulesetOptions. # noqa: E501
What type of emails actions to apply ruleset to. Either
SENDING_EMAILSorRECEIVING_EMAILSwill apply action and target to any sending or receiving of emails respectively. # noqa: E501:return: The scope of this CreateInboxRulesetOptions. # noqa: E501 :rtype: str
Expand source code
@property def scope(self): """Gets the scope of this CreateInboxRulesetOptions. # noqa: E501 What type of emails actions to apply ruleset to. Either `SENDING_EMAILS` or `RECEIVING_EMAILS` will apply action and target to any sending or receiving of emails respectively. # noqa: E501 :return: The scope of this CreateInboxRulesetOptions. # noqa: E501 :rtype: str """ return self._scope var target-
Gets the target of this CreateInboxRulesetOptions. # noqa: E501
Target to match emails with. Can be a wild-card type pattern or a valid email address. For instance
*@gmail.commatches all gmail addresses whiletest@gmail.commatches one address exactly. The target is applied to every recipient field email address whenSENDING_EMAILSis the scope and is applied to sender of email whenRECEIVING_EMAILS. # noqa: E501:return: The target of this CreateInboxRulesetOptions. # noqa: E501 :rtype: str
Expand source code
@property def target(self): """Gets the target of this CreateInboxRulesetOptions. # noqa: E501 Target to match emails with. Can be a wild-card type pattern or a valid email address. For instance `*@gmail.com` matches all gmail addresses while `test@gmail.com` matches one address exactly. The target is applied to every recipient field email address when `SENDING_EMAILS` is the scope and is applied to sender of email when `RECEIVING_EMAILS`. # noqa: E501 :return: The target of this CreateInboxRulesetOptions. # noqa: E501 :rtype: str """ return self._target
Methods
def to_dict(self)-
Returns the model properties as a dict
Expand source code
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
Expand source code
def to_str(self): """Returns the string representation of the model""" return pprint.pformat(self.to_dict())