Module mailslurp_client.models.update_inbox_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 UpdateInboxOptions(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 = {
'name': 'str',
'description': 'str',
'tags': 'list[str]',
'expires_at': 'datetime',
'favourite': 'bool'
}
attribute_map = {
'name': 'name',
'description': 'description',
'tags': 'tags',
'expires_at': 'expiresAt',
'favourite': 'favourite'
}
def __init__(self, name=None, description=None, tags=None, expires_at=None, favourite=None, local_vars_configuration=None): # noqa: E501
"""UpdateInboxOptions - 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._name = None
self._description = None
self._tags = None
self._expires_at = None
self._favourite = None
self.discriminator = None
self.name = name
self.description = description
self.tags = tags
self.expires_at = expires_at
self.favourite = favourite
@property
def name(self):
"""Gets the name of this UpdateInboxOptions. # noqa: E501
Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search # noqa: E501
:return: The name of this UpdateInboxOptions. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this UpdateInboxOptions.
Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search # noqa: E501
:param name: The name of this UpdateInboxOptions. # noqa: E501
:type: str
"""
self._name = name
@property
def description(self):
"""Gets the description of this UpdateInboxOptions. # noqa: E501
Description of an inbox for labelling and searching purposes # noqa: E501
:return: The description of this UpdateInboxOptions. # noqa: E501
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""Sets the description of this UpdateInboxOptions.
Description of an inbox for labelling and searching purposes # noqa: E501
:param description: The description of this UpdateInboxOptions. # noqa: E501
:type: str
"""
self._description = description
@property
def tags(self):
"""Gets the tags of this UpdateInboxOptions. # noqa: E501
Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. # noqa: E501
:return: The tags of this UpdateInboxOptions. # noqa: E501
:rtype: list[str]
"""
return self._tags
@tags.setter
def tags(self, tags):
"""Sets the tags of this UpdateInboxOptions.
Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. # noqa: E501
:param tags: The tags of this UpdateInboxOptions. # noqa: E501
:type: list[str]
"""
self._tags = tags
@property
def expires_at(self):
"""Gets the expires_at of this UpdateInboxOptions. # noqa: E501
Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email. # noqa: E501
:return: The expires_at of this UpdateInboxOptions. # noqa: E501
:rtype: datetime
"""
return self._expires_at
@expires_at.setter
def expires_at(self, expires_at):
"""Sets the expires_at of this UpdateInboxOptions.
Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email. # noqa: E501
:param expires_at: The expires_at of this UpdateInboxOptions. # noqa: E501
:type: datetime
"""
self._expires_at = expires_at
@property
def favourite(self):
"""Gets the favourite of this UpdateInboxOptions. # noqa: E501
Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering # noqa: E501
:return: The favourite of this UpdateInboxOptions. # noqa: E501
:rtype: bool
"""
return self._favourite
@favourite.setter
def favourite(self, favourite):
"""Sets the favourite of this UpdateInboxOptions.
Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering # noqa: E501
:param favourite: The favourite of this UpdateInboxOptions. # noqa: E501
:type: bool
"""
self._favourite = favourite
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, UpdateInboxOptions):
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, UpdateInboxOptions):
return True
return self.to_dict() != other.to_dict()Classes
class UpdateInboxOptions (name=None, description=None, tags=None, expires_at=None, favourite=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.
UpdateInboxOptions - a model defined in OpenAPI
Expand source code
class UpdateInboxOptions(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 = { 'name': 'str', 'description': 'str', 'tags': 'list[str]', 'expires_at': 'datetime', 'favourite': 'bool' } attribute_map = { 'name': 'name', 'description': 'description', 'tags': 'tags', 'expires_at': 'expiresAt', 'favourite': 'favourite' } def __init__(self, name=None, description=None, tags=None, expires_at=None, favourite=None, local_vars_configuration=None): # noqa: E501 """UpdateInboxOptions - 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._name = None self._description = None self._tags = None self._expires_at = None self._favourite = None self.discriminator = None self.name = name self.description = description self.tags = tags self.expires_at = expires_at self.favourite = favourite @property def name(self): """Gets the name of this UpdateInboxOptions. # noqa: E501 Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search # noqa: E501 :return: The name of this UpdateInboxOptions. # noqa: E501 :rtype: str """ return self._name @name.setter def name(self, name): """Sets the name of this UpdateInboxOptions. Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search # noqa: E501 :param name: The name of this UpdateInboxOptions. # noqa: E501 :type: str """ self._name = name @property def description(self): """Gets the description of this UpdateInboxOptions. # noqa: E501 Description of an inbox for labelling and searching purposes # noqa: E501 :return: The description of this UpdateInboxOptions. # noqa: E501 :rtype: str """ return self._description @description.setter def description(self, description): """Sets the description of this UpdateInboxOptions. Description of an inbox for labelling and searching purposes # noqa: E501 :param description: The description of this UpdateInboxOptions. # noqa: E501 :type: str """ self._description = description @property def tags(self): """Gets the tags of this UpdateInboxOptions. # noqa: E501 Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. # noqa: E501 :return: The tags of this UpdateInboxOptions. # noqa: E501 :rtype: list[str] """ return self._tags @tags.setter def tags(self, tags): """Sets the tags of this UpdateInboxOptions. Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. # noqa: E501 :param tags: The tags of this UpdateInboxOptions. # noqa: E501 :type: list[str] """ self._tags = tags @property def expires_at(self): """Gets the expires_at of this UpdateInboxOptions. # noqa: E501 Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email. # noqa: E501 :return: The expires_at of this UpdateInboxOptions. # noqa: E501 :rtype: datetime """ return self._expires_at @expires_at.setter def expires_at(self, expires_at): """Sets the expires_at of this UpdateInboxOptions. Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email. # noqa: E501 :param expires_at: The expires_at of this UpdateInboxOptions. # noqa: E501 :type: datetime """ self._expires_at = expires_at @property def favourite(self): """Gets the favourite of this UpdateInboxOptions. # noqa: E501 Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering # noqa: E501 :return: The favourite of this UpdateInboxOptions. # noqa: E501 :rtype: bool """ return self._favourite @favourite.setter def favourite(self, favourite): """Sets the favourite of this UpdateInboxOptions. Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering # noqa: E501 :param favourite: The favourite of this UpdateInboxOptions. # noqa: E501 :type: bool """ self._favourite = favourite 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, UpdateInboxOptions): 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, UpdateInboxOptions): return True return self.to_dict() != other.to_dict()Class variables
var attribute_mapvar openapi_types
Instance variables
var description-
Gets the description of this UpdateInboxOptions. # noqa: E501
Description of an inbox for labelling and searching purposes # noqa: E501
:return: The description of this UpdateInboxOptions. # noqa: E501 :rtype: str
Expand source code
@property def description(self): """Gets the description of this UpdateInboxOptions. # noqa: E501 Description of an inbox for labelling and searching purposes # noqa: E501 :return: The description of this UpdateInboxOptions. # noqa: E501 :rtype: str """ return self._description var expires_at-
Gets the expires_at of this UpdateInboxOptions. # noqa: E501
Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email. # noqa: E501
:return: The expires_at of this UpdateInboxOptions. # noqa: E501 :rtype: datetime
Expand source code
@property def expires_at(self): """Gets the expires_at of this UpdateInboxOptions. # noqa: E501 Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email. # noqa: E501 :return: The expires_at of this UpdateInboxOptions. # noqa: E501 :rtype: datetime """ return self._expires_at var favourite-
Gets the favourite of this UpdateInboxOptions. # noqa: E501
Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering # noqa: E501
:return: The favourite of this UpdateInboxOptions. # noqa: E501 :rtype: bool
Expand source code
@property def favourite(self): """Gets the favourite of this UpdateInboxOptions. # noqa: E501 Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering # noqa: E501 :return: The favourite of this UpdateInboxOptions. # noqa: E501 :rtype: bool """ return self._favourite var name-
Gets the name of this UpdateInboxOptions. # noqa: E501
Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search # noqa: E501
:return: The name of this UpdateInboxOptions. # noqa: E501 :rtype: str
Expand source code
@property def name(self): """Gets the name of this UpdateInboxOptions. # noqa: E501 Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search # noqa: E501 :return: The name of this UpdateInboxOptions. # noqa: E501 :rtype: str """ return self._name -
Gets the tags of this UpdateInboxOptions. # noqa: E501
Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. # noqa: E501
:return: The tags of this UpdateInboxOptions. # noqa: E501 :rtype: list[str]
Expand source code
@property def tags(self): """Gets the tags of this UpdateInboxOptions. # noqa: E501 Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. # noqa: E501 :return: The tags of this UpdateInboxOptions. # noqa: E501 :rtype: list[str] """ return self._tags
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())