Module mailslurp_client.models.create_alias_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 CreateAliasOptions(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 = {
'email_address': 'str',
'inbox_id': 'str',
'name': 'str',
'use_threads': 'bool',
'domain_id': 'str',
'verify_email_address': 'bool'
}
attribute_map = {
'email_address': 'emailAddress',
'inbox_id': 'inboxId',
'name': 'name',
'use_threads': 'useThreads',
'domain_id': 'domainId',
'verify_email_address': 'verifyEmailAddress'
}
def __init__(self, email_address=None, inbox_id=None, name=None, use_threads=None, domain_id=None, verify_email_address=None, local_vars_configuration=None): # noqa: E501
"""CreateAliasOptions - 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._email_address = None
self._inbox_id = None
self._name = None
self._use_threads = None
self._domain_id = None
self._verify_email_address = None
self.discriminator = None
self.email_address = email_address
self.inbox_id = inbox_id
self.name = name
self.use_threads = use_threads
self.domain_id = domain_id
self.verify_email_address = verify_email_address
@property
def email_address(self):
"""Gets the email_address of this CreateAliasOptions. # noqa: E501
Email address to be hidden behind alias. Emails sent to the alias email address will be forwarded to this address. If you want to enable replies set useThreads true and the reply-to for the email will allow outbound communication via a thread. Some email addresses may require verification if they are not added as a contact first. # noqa: E501
:return: The email_address of this CreateAliasOptions. # noqa: E501
:rtype: str
"""
return self._email_address
@email_address.setter
def email_address(self, email_address):
"""Sets the email_address of this CreateAliasOptions.
Email address to be hidden behind alias. Emails sent to the alias email address will be forwarded to this address. If you want to enable replies set useThreads true and the reply-to for the email will allow outbound communication via a thread. Some email addresses may require verification if they are not added as a contact first. # noqa: E501
:param email_address: The email_address of this CreateAliasOptions. # noqa: E501
:type: str
"""
if self.local_vars_configuration.client_side_validation and email_address is None: # noqa: E501
raise ValueError("Invalid value for `email_address`, must not be `None`") # noqa: E501
self._email_address = email_address
@property
def inbox_id(self):
"""Gets the inbox_id of this CreateAliasOptions. # noqa: E501
Optional inbox ID to attach to alias. Null by default means an a new inbox will be created for the alias. Use a custom inbox to control what email address the alias uses. To use custom email addresses create a domain and an inbox, the use the inbox ID with this call. Emails received by this inbox will be forwarded to the alias email address # noqa: E501
:return: The inbox_id of this CreateAliasOptions. # noqa: E501
:rtype: str
"""
return self._inbox_id
@inbox_id.setter
def inbox_id(self, inbox_id):
"""Sets the inbox_id of this CreateAliasOptions.
Optional inbox ID to attach to alias. Null by default means an a new inbox will be created for the alias. Use a custom inbox to control what email address the alias uses. To use custom email addresses create a domain and an inbox, the use the inbox ID with this call. Emails received by this inbox will be forwarded to the alias email address # noqa: E501
:param inbox_id: The inbox_id of this CreateAliasOptions. # noqa: E501
:type: str
"""
self._inbox_id = inbox_id
@property
def name(self):
"""Gets the name of this CreateAliasOptions. # noqa: E501
Optional name for alias # noqa: E501
:return: The name of this CreateAliasOptions. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this CreateAliasOptions.
Optional name for alias # noqa: E501
:param name: The name of this CreateAliasOptions. # noqa: E501
:type: str
"""
self._name = name
@property
def use_threads(self):
"""Gets the use_threads of this CreateAliasOptions. # noqa: E501
Enable threads options. If true emails will be sent with a unique reply-to thread address. This means you can reply to the forwarded email and it will be sent to the recipients via your alias address. That way a thread conversation is preserved. # noqa: E501
:return: The use_threads of this CreateAliasOptions. # noqa: E501
:rtype: bool
"""
return self._use_threads
@use_threads.setter
def use_threads(self, use_threads):
"""Sets the use_threads of this CreateAliasOptions.
Enable threads options. If true emails will be sent with a unique reply-to thread address. This means you can reply to the forwarded email and it will be sent to the recipients via your alias address. That way a thread conversation is preserved. # noqa: E501
:param use_threads: The use_threads of this CreateAliasOptions. # noqa: E501
:type: bool
"""
if self.local_vars_configuration.client_side_validation and use_threads is None: # noqa: E501
raise ValueError("Invalid value for `use_threads`, must not be `None`") # noqa: E501
self._use_threads = use_threads
@property
def domain_id(self):
"""Gets the domain_id of this CreateAliasOptions. # noqa: E501
Custom domain ID to use when generating alias email addresses # noqa: E501
:return: The domain_id of this CreateAliasOptions. # noqa: E501
:rtype: str
"""
return self._domain_id
@domain_id.setter
def domain_id(self, domain_id):
"""Sets the domain_id of this CreateAliasOptions.
Custom domain ID to use when generating alias email addresses # noqa: E501
:param domain_id: The domain_id of this CreateAliasOptions. # noqa: E501
:type: str
"""
self._domain_id = domain_id
@property
def verify_email_address(self):
"""Gets the verify_email_address of this CreateAliasOptions. # noqa: E501
Whether to verify the masked email address exists before sending an email to it # noqa: E501
:return: The verify_email_address of this CreateAliasOptions. # noqa: E501
:rtype: bool
"""
return self._verify_email_address
@verify_email_address.setter
def verify_email_address(self, verify_email_address):
"""Sets the verify_email_address of this CreateAliasOptions.
Whether to verify the masked email address exists before sending an email to it # noqa: E501
:param verify_email_address: The verify_email_address of this CreateAliasOptions. # noqa: E501
:type: bool
"""
self._verify_email_address = verify_email_address
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, CreateAliasOptions):
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, CreateAliasOptions):
return True
return self.to_dict() != other.to_dict()Classes
class CreateAliasOptions (email_address=None, inbox_id=None, name=None, use_threads=None, domain_id=None, verify_email_address=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.
CreateAliasOptions - a model defined in OpenAPI
Expand source code
class CreateAliasOptions(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 = { 'email_address': 'str', 'inbox_id': 'str', 'name': 'str', 'use_threads': 'bool', 'domain_id': 'str', 'verify_email_address': 'bool' } attribute_map = { 'email_address': 'emailAddress', 'inbox_id': 'inboxId', 'name': 'name', 'use_threads': 'useThreads', 'domain_id': 'domainId', 'verify_email_address': 'verifyEmailAddress' } def __init__(self, email_address=None, inbox_id=None, name=None, use_threads=None, domain_id=None, verify_email_address=None, local_vars_configuration=None): # noqa: E501 """CreateAliasOptions - 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._email_address = None self._inbox_id = None self._name = None self._use_threads = None self._domain_id = None self._verify_email_address = None self.discriminator = None self.email_address = email_address self.inbox_id = inbox_id self.name = name self.use_threads = use_threads self.domain_id = domain_id self.verify_email_address = verify_email_address @property def email_address(self): """Gets the email_address of this CreateAliasOptions. # noqa: E501 Email address to be hidden behind alias. Emails sent to the alias email address will be forwarded to this address. If you want to enable replies set useThreads true and the reply-to for the email will allow outbound communication via a thread. Some email addresses may require verification if they are not added as a contact first. # noqa: E501 :return: The email_address of this CreateAliasOptions. # noqa: E501 :rtype: str """ return self._email_address @email_address.setter def email_address(self, email_address): """Sets the email_address of this CreateAliasOptions. Email address to be hidden behind alias. Emails sent to the alias email address will be forwarded to this address. If you want to enable replies set useThreads true and the reply-to for the email will allow outbound communication via a thread. Some email addresses may require verification if they are not added as a contact first. # noqa: E501 :param email_address: The email_address of this CreateAliasOptions. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and email_address is None: # noqa: E501 raise ValueError("Invalid value for `email_address`, must not be `None`") # noqa: E501 self._email_address = email_address @property def inbox_id(self): """Gets the inbox_id of this CreateAliasOptions. # noqa: E501 Optional inbox ID to attach to alias. Null by default means an a new inbox will be created for the alias. Use a custom inbox to control what email address the alias uses. To use custom email addresses create a domain and an inbox, the use the inbox ID with this call. Emails received by this inbox will be forwarded to the alias email address # noqa: E501 :return: The inbox_id of this CreateAliasOptions. # noqa: E501 :rtype: str """ return self._inbox_id @inbox_id.setter def inbox_id(self, inbox_id): """Sets the inbox_id of this CreateAliasOptions. Optional inbox ID to attach to alias. Null by default means an a new inbox will be created for the alias. Use a custom inbox to control what email address the alias uses. To use custom email addresses create a domain and an inbox, the use the inbox ID with this call. Emails received by this inbox will be forwarded to the alias email address # noqa: E501 :param inbox_id: The inbox_id of this CreateAliasOptions. # noqa: E501 :type: str """ self._inbox_id = inbox_id @property def name(self): """Gets the name of this CreateAliasOptions. # noqa: E501 Optional name for alias # noqa: E501 :return: The name of this CreateAliasOptions. # noqa: E501 :rtype: str """ return self._name @name.setter def name(self, name): """Sets the name of this CreateAliasOptions. Optional name for alias # noqa: E501 :param name: The name of this CreateAliasOptions. # noqa: E501 :type: str """ self._name = name @property def use_threads(self): """Gets the use_threads of this CreateAliasOptions. # noqa: E501 Enable threads options. If true emails will be sent with a unique reply-to thread address. This means you can reply to the forwarded email and it will be sent to the recipients via your alias address. That way a thread conversation is preserved. # noqa: E501 :return: The use_threads of this CreateAliasOptions. # noqa: E501 :rtype: bool """ return self._use_threads @use_threads.setter def use_threads(self, use_threads): """Sets the use_threads of this CreateAliasOptions. Enable threads options. If true emails will be sent with a unique reply-to thread address. This means you can reply to the forwarded email and it will be sent to the recipients via your alias address. That way a thread conversation is preserved. # noqa: E501 :param use_threads: The use_threads of this CreateAliasOptions. # noqa: E501 :type: bool """ if self.local_vars_configuration.client_side_validation and use_threads is None: # noqa: E501 raise ValueError("Invalid value for `use_threads`, must not be `None`") # noqa: E501 self._use_threads = use_threads @property def domain_id(self): """Gets the domain_id of this CreateAliasOptions. # noqa: E501 Custom domain ID to use when generating alias email addresses # noqa: E501 :return: The domain_id of this CreateAliasOptions. # noqa: E501 :rtype: str """ return self._domain_id @domain_id.setter def domain_id(self, domain_id): """Sets the domain_id of this CreateAliasOptions. Custom domain ID to use when generating alias email addresses # noqa: E501 :param domain_id: The domain_id of this CreateAliasOptions. # noqa: E501 :type: str """ self._domain_id = domain_id @property def verify_email_address(self): """Gets the verify_email_address of this CreateAliasOptions. # noqa: E501 Whether to verify the masked email address exists before sending an email to it # noqa: E501 :return: The verify_email_address of this CreateAliasOptions. # noqa: E501 :rtype: bool """ return self._verify_email_address @verify_email_address.setter def verify_email_address(self, verify_email_address): """Sets the verify_email_address of this CreateAliasOptions. Whether to verify the masked email address exists before sending an email to it # noqa: E501 :param verify_email_address: The verify_email_address of this CreateAliasOptions. # noqa: E501 :type: bool """ self._verify_email_address = verify_email_address 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, CreateAliasOptions): 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, CreateAliasOptions): return True return self.to_dict() != other.to_dict()Class variables
var attribute_mapvar openapi_types
Instance variables
var domain_id-
Gets the domain_id of this CreateAliasOptions. # noqa: E501
Custom domain ID to use when generating alias email addresses # noqa: E501
:return: The domain_id of this CreateAliasOptions. # noqa: E501 :rtype: str
Expand source code
@property def domain_id(self): """Gets the domain_id of this CreateAliasOptions. # noqa: E501 Custom domain ID to use when generating alias email addresses # noqa: E501 :return: The domain_id of this CreateAliasOptions. # noqa: E501 :rtype: str """ return self._domain_id var email_address-
Gets the email_address of this CreateAliasOptions. # noqa: E501
Email address to be hidden behind alias. Emails sent to the alias email address will be forwarded to this address. If you want to enable replies set useThreads true and the reply-to for the email will allow outbound communication via a thread. Some email addresses may require verification if they are not added as a contact first. # noqa: E501
:return: The email_address of this CreateAliasOptions. # noqa: E501 :rtype: str
Expand source code
@property def email_address(self): """Gets the email_address of this CreateAliasOptions. # noqa: E501 Email address to be hidden behind alias. Emails sent to the alias email address will be forwarded to this address. If you want to enable replies set useThreads true and the reply-to for the email will allow outbound communication via a thread. Some email addresses may require verification if they are not added as a contact first. # noqa: E501 :return: The email_address of this CreateAliasOptions. # noqa: E501 :rtype: str """ return self._email_address var inbox_id-
Gets the inbox_id of this CreateAliasOptions. # noqa: E501
Optional inbox ID to attach to alias. Null by default means an a new inbox will be created for the alias. Use a custom inbox to control what email address the alias uses. To use custom email addresses create a domain and an inbox, the use the inbox ID with this call. Emails received by this inbox will be forwarded to the alias email address # noqa: E501
:return: The inbox_id of this CreateAliasOptions. # noqa: E501 :rtype: str
Expand source code
@property def inbox_id(self): """Gets the inbox_id of this CreateAliasOptions. # noqa: E501 Optional inbox ID to attach to alias. Null by default means an a new inbox will be created for the alias. Use a custom inbox to control what email address the alias uses. To use custom email addresses create a domain and an inbox, the use the inbox ID with this call. Emails received by this inbox will be forwarded to the alias email address # noqa: E501 :return: The inbox_id of this CreateAliasOptions. # noqa: E501 :rtype: str """ return self._inbox_id var name-
Gets the name of this CreateAliasOptions. # noqa: E501
Optional name for alias # noqa: E501
:return: The name of this CreateAliasOptions. # noqa: E501 :rtype: str
Expand source code
@property def name(self): """Gets the name of this CreateAliasOptions. # noqa: E501 Optional name for alias # noqa: E501 :return: The name of this CreateAliasOptions. # noqa: E501 :rtype: str """ return self._name var use_threads-
Gets the use_threads of this CreateAliasOptions. # noqa: E501
Enable threads options. If true emails will be sent with a unique reply-to thread address. This means you can reply to the forwarded email and it will be sent to the recipients via your alias address. That way a thread conversation is preserved. # noqa: E501
:return: The use_threads of this CreateAliasOptions. # noqa: E501 :rtype: bool
Expand source code
@property def use_threads(self): """Gets the use_threads of this CreateAliasOptions. # noqa: E501 Enable threads options. If true emails will be sent with a unique reply-to thread address. This means you can reply to the forwarded email and it will be sent to the recipients via your alias address. That way a thread conversation is preserved. # noqa: E501 :return: The use_threads of this CreateAliasOptions. # noqa: E501 :rtype: bool """ return self._use_threads var verify_email_address-
Gets the verify_email_address of this CreateAliasOptions. # noqa: E501
Whether to verify the masked email address exists before sending an email to it # noqa: E501
:return: The verify_email_address of this CreateAliasOptions. # noqa: E501 :rtype: bool
Expand source code
@property def verify_email_address(self): """Gets the verify_email_address of this CreateAliasOptions. # noqa: E501 Whether to verify the masked email address exists before sending an email to it # noqa: E501 :return: The verify_email_address of this CreateAliasOptions. # noqa: E501 :rtype: bool """ return self._verify_email_address
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())