Module mailslurp_client.models.create_domain_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 CreateDomainOptions(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',
'description': 'str',
'created_catch_all_inbox': 'bool',
'domain_type': 'str'
}
attribute_map = {
'domain': 'domain',
'description': 'description',
'created_catch_all_inbox': 'createdCatchAllInbox',
'domain_type': 'domainType'
}
def __init__(self, domain=None, description=None, created_catch_all_inbox=None, domain_type=None, local_vars_configuration=None): # noqa: E501
"""CreateDomainOptions - 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._description = None
self._created_catch_all_inbox = None
self._domain_type = None
self.discriminator = None
self.domain = domain
self.description = description
self.created_catch_all_inbox = created_catch_all_inbox
self.domain_type = domain_type
@property
def domain(self):
"""Gets the domain of this CreateDomainOptions. # noqa: E501
The top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So `test.com` covers all subdomains such as `mail.test.com`. Don't include a protocol such as `http://`. Once added you must complete the verification steps by adding the returned records to your domain. # noqa: E501
:return: The domain of this CreateDomainOptions. # noqa: E501
:rtype: str
"""
return self._domain
@domain.setter
def domain(self, domain):
"""Sets the domain of this CreateDomainOptions.
The top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So `test.com` covers all subdomains such as `mail.test.com`. Don't include a protocol such as `http://`. Once added you must complete the verification steps by adding the returned records to your domain. # noqa: E501
:param domain: The domain of this CreateDomainOptions. # noqa: E501
:type: str
"""
if self.local_vars_configuration.client_side_validation and domain is None: # noqa: E501
raise ValueError("Invalid value for `domain`, must not be `None`") # noqa: E501
self._domain = domain
@property
def description(self):
"""Gets the description of this CreateDomainOptions. # noqa: E501
Optional description of the domain. # noqa: E501
:return: The description of this CreateDomainOptions. # noqa: E501
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""Sets the description of this CreateDomainOptions.
Optional description of the domain. # noqa: E501
:param description: The description of this CreateDomainOptions. # noqa: E501
:type: str
"""
self._description = description
@property
def created_catch_all_inbox(self):
"""Gets the created_catch_all_inbox of this CreateDomainOptions. # noqa: E501
Whether to create a catch all inbox for the domain. Any email sent to an address using your domain that cannot be matched to an existing inbox you created with the domain will be routed to the created catch all inbox. You can access emails using the regular methods on this inbox ID. # noqa: E501
:return: The created_catch_all_inbox of this CreateDomainOptions. # noqa: E501
:rtype: bool
"""
return self._created_catch_all_inbox
@created_catch_all_inbox.setter
def created_catch_all_inbox(self, created_catch_all_inbox):
"""Sets the created_catch_all_inbox of this CreateDomainOptions.
Whether to create a catch all inbox for the domain. Any email sent to an address using your domain that cannot be matched to an existing inbox you created with the domain will be routed to the created catch all inbox. You can access emails using the regular methods on this inbox ID. # noqa: E501
:param created_catch_all_inbox: The created_catch_all_inbox of this CreateDomainOptions. # noqa: E501
:type: bool
"""
self._created_catch_all_inbox = created_catch_all_inbox
@property
def domain_type(self):
"""Gets the domain_type of this CreateDomainOptions. # noqa: E501
Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails. # noqa: E501
:return: The domain_type of this CreateDomainOptions. # noqa: E501
:rtype: str
"""
return self._domain_type
@domain_type.setter
def domain_type(self, domain_type):
"""Sets the domain_type of this CreateDomainOptions.
Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails. # noqa: E501
:param domain_type: The domain_type of this CreateDomainOptions. # noqa: E501
:type: str
"""
allowed_values = [None,"HTTP_INBOX", "SMTP_DOMAIN"] # noqa: E501
if self.local_vars_configuration.client_side_validation and domain_type not in allowed_values: # noqa: E501
raise ValueError(
"Invalid value for `domain_type` ({0}), must be one of {1}" # noqa: E501
.format(domain_type, allowed_values)
)
self._domain_type = domain_type
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, CreateDomainOptions):
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, CreateDomainOptions):
return True
return self.to_dict() != other.to_dict()Classes
class CreateDomainOptions (domain=None, description=None, created_catch_all_inbox=None, domain_type=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.
CreateDomainOptions - a model defined in OpenAPI
Expand source code
class CreateDomainOptions(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', 'description': 'str', 'created_catch_all_inbox': 'bool', 'domain_type': 'str' } attribute_map = { 'domain': 'domain', 'description': 'description', 'created_catch_all_inbox': 'createdCatchAllInbox', 'domain_type': 'domainType' } def __init__(self, domain=None, description=None, created_catch_all_inbox=None, domain_type=None, local_vars_configuration=None): # noqa: E501 """CreateDomainOptions - 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._description = None self._created_catch_all_inbox = None self._domain_type = None self.discriminator = None self.domain = domain self.description = description self.created_catch_all_inbox = created_catch_all_inbox self.domain_type = domain_type @property def domain(self): """Gets the domain of this CreateDomainOptions. # noqa: E501 The top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So `test.com` covers all subdomains such as `mail.test.com`. Don't include a protocol such as `http://`. Once added you must complete the verification steps by adding the returned records to your domain. # noqa: E501 :return: The domain of this CreateDomainOptions. # noqa: E501 :rtype: str """ return self._domain @domain.setter def domain(self, domain): """Sets the domain of this CreateDomainOptions. The top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So `test.com` covers all subdomains such as `mail.test.com`. Don't include a protocol such as `http://`. Once added you must complete the verification steps by adding the returned records to your domain. # noqa: E501 :param domain: The domain of this CreateDomainOptions. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and domain is None: # noqa: E501 raise ValueError("Invalid value for `domain`, must not be `None`") # noqa: E501 self._domain = domain @property def description(self): """Gets the description of this CreateDomainOptions. # noqa: E501 Optional description of the domain. # noqa: E501 :return: The description of this CreateDomainOptions. # noqa: E501 :rtype: str """ return self._description @description.setter def description(self, description): """Sets the description of this CreateDomainOptions. Optional description of the domain. # noqa: E501 :param description: The description of this CreateDomainOptions. # noqa: E501 :type: str """ self._description = description @property def created_catch_all_inbox(self): """Gets the created_catch_all_inbox of this CreateDomainOptions. # noqa: E501 Whether to create a catch all inbox for the domain. Any email sent to an address using your domain that cannot be matched to an existing inbox you created with the domain will be routed to the created catch all inbox. You can access emails using the regular methods on this inbox ID. # noqa: E501 :return: The created_catch_all_inbox of this CreateDomainOptions. # noqa: E501 :rtype: bool """ return self._created_catch_all_inbox @created_catch_all_inbox.setter def created_catch_all_inbox(self, created_catch_all_inbox): """Sets the created_catch_all_inbox of this CreateDomainOptions. Whether to create a catch all inbox for the domain. Any email sent to an address using your domain that cannot be matched to an existing inbox you created with the domain will be routed to the created catch all inbox. You can access emails using the regular methods on this inbox ID. # noqa: E501 :param created_catch_all_inbox: The created_catch_all_inbox of this CreateDomainOptions. # noqa: E501 :type: bool """ self._created_catch_all_inbox = created_catch_all_inbox @property def domain_type(self): """Gets the domain_type of this CreateDomainOptions. # noqa: E501 Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails. # noqa: E501 :return: The domain_type of this CreateDomainOptions. # noqa: E501 :rtype: str """ return self._domain_type @domain_type.setter def domain_type(self, domain_type): """Sets the domain_type of this CreateDomainOptions. Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails. # noqa: E501 :param domain_type: The domain_type of this CreateDomainOptions. # noqa: E501 :type: str """ allowed_values = [None,"HTTP_INBOX", "SMTP_DOMAIN"] # noqa: E501 if self.local_vars_configuration.client_side_validation and domain_type not in allowed_values: # noqa: E501 raise ValueError( "Invalid value for `domain_type` ({0}), must be one of {1}" # noqa: E501 .format(domain_type, allowed_values) ) self._domain_type = domain_type 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, CreateDomainOptions): 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, CreateDomainOptions): return True return self.to_dict() != other.to_dict()Class variables
var attribute_mapvar openapi_types
Instance variables
var created_catch_all_inbox-
Gets the created_catch_all_inbox of this CreateDomainOptions. # noqa: E501
Whether to create a catch all inbox for the domain. Any email sent to an address using your domain that cannot be matched to an existing inbox you created with the domain will be routed to the created catch all inbox. You can access emails using the regular methods on this inbox ID. # noqa: E501
:return: The created_catch_all_inbox of this CreateDomainOptions. # noqa: E501 :rtype: bool
Expand source code
@property def created_catch_all_inbox(self): """Gets the created_catch_all_inbox of this CreateDomainOptions. # noqa: E501 Whether to create a catch all inbox for the domain. Any email sent to an address using your domain that cannot be matched to an existing inbox you created with the domain will be routed to the created catch all inbox. You can access emails using the regular methods on this inbox ID. # noqa: E501 :return: The created_catch_all_inbox of this CreateDomainOptions. # noqa: E501 :rtype: bool """ return self._created_catch_all_inbox var description-
Gets the description of this CreateDomainOptions. # noqa: E501
Optional description of the domain. # noqa: E501
:return: The description of this CreateDomainOptions. # noqa: E501 :rtype: str
Expand source code
@property def description(self): """Gets the description of this CreateDomainOptions. # noqa: E501 Optional description of the domain. # noqa: E501 :return: The description of this CreateDomainOptions. # noqa: E501 :rtype: str """ return self._description var domain-
Gets the domain of this CreateDomainOptions. # noqa: E501
The top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So
test.comcovers all subdomains such asmail.test.com. Don't include a protocol such ashttp://. Once added you must complete the verification steps by adding the returned records to your domain. # noqa: E501:return: The domain of this CreateDomainOptions. # noqa: E501 :rtype: str
Expand source code
@property def domain(self): """Gets the domain of this CreateDomainOptions. # noqa: E501 The top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So `test.com` covers all subdomains such as `mail.test.com`. Don't include a protocol such as `http://`. Once added you must complete the verification steps by adding the returned records to your domain. # noqa: E501 :return: The domain of this CreateDomainOptions. # noqa: E501 :rtype: str """ return self._domain var domain_type-
Gets the domain_type of this CreateDomainOptions. # noqa: E501
Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails. # noqa: E501
:return: The domain_type of this CreateDomainOptions. # noqa: E501 :rtype: str
Expand source code
@property def domain_type(self): """Gets the domain_type of this CreateDomainOptions. # noqa: E501 Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails. # noqa: E501 :return: The domain_type of this CreateDomainOptions. # noqa: E501 :rtype: str """ return self._domain_type
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())