Module mailslurp_client.models.sending_connection_dto
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 SendingConnectionDto (id=None, name=None, provider=None, provider_preset=None, capabilities=None, from_email=None, smtp_host=None, smtp_port=None, smtp_security=None, username_hint=None, api_region=None, sending_domain=None, status=None, enabled=None, last_verified_at=None, last_error_code=None, created_at=None, updated_at=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.
SendingConnectionDto - a model defined in OpenAPI
Expand source code
class SendingConnectionDto(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 = { 'id': 'str', 'name': 'str', 'provider': 'str', 'provider_preset': 'str', 'capabilities': 'list[str]', 'from_email': 'str', 'smtp_host': 'str', 'smtp_port': 'int', 'smtp_security': 'str', 'username_hint': 'str', 'api_region': 'str', 'sending_domain': 'str', 'status': 'str', 'enabled': 'bool', 'last_verified_at': 'datetime', 'last_error_code': 'str', 'created_at': 'datetime', 'updated_at': 'datetime' } attribute_map = { 'id': 'id', 'name': 'name', 'provider': 'provider', 'provider_preset': 'providerPreset', 'capabilities': 'capabilities', 'from_email': 'fromEmail', 'smtp_host': 'smtpHost', 'smtp_port': 'smtpPort', 'smtp_security': 'smtpSecurity', 'username_hint': 'usernameHint', 'api_region': 'apiRegion', 'sending_domain': 'sendingDomain', 'status': 'status', 'enabled': 'enabled', 'last_verified_at': 'lastVerifiedAt', 'last_error_code': 'lastErrorCode', 'created_at': 'createdAt', 'updated_at': 'updatedAt' } def __init__(self, id=None, name=None, provider=None, provider_preset=None, capabilities=None, from_email=None, smtp_host=None, smtp_port=None, smtp_security=None, username_hint=None, api_region=None, sending_domain=None, status=None, enabled=None, last_verified_at=None, last_error_code=None, created_at=None, updated_at=None, local_vars_configuration=None): # noqa: E501 """SendingConnectionDto - 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._id = None self._name = None self._provider = None self._provider_preset = None self._capabilities = None self._from_email = None self._smtp_host = None self._smtp_port = None self._smtp_security = None self._username_hint = None self._api_region = None self._sending_domain = None self._status = None self._enabled = None self._last_verified_at = None self._last_error_code = None self._created_at = None self._updated_at = None self.discriminator = None self.id = id self.name = name self.provider = provider self.provider_preset = provider_preset self.capabilities = capabilities self.from_email = from_email self.smtp_host = smtp_host self.smtp_port = smtp_port self.smtp_security = smtp_security self.username_hint = username_hint self.api_region = api_region self.sending_domain = sending_domain self.status = status self.enabled = enabled self.last_verified_at = last_verified_at self.last_error_code = last_error_code self.created_at = created_at self.updated_at = updated_at @property def id(self): """Gets the id of this SendingConnectionDto. # noqa: E501 :return: The id of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): """Sets the id of this SendingConnectionDto. :param id: The id of this SendingConnectionDto. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and id is None: # noqa: E501 raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501 self._id = id @property def name(self): """Gets the name of this SendingConnectionDto. # noqa: E501 :return: The name of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._name @name.setter def name(self, name): """Sets the name of this SendingConnectionDto. :param name: The name of this SendingConnectionDto. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and name is None: # noqa: E501 raise ValueError("Invalid value for `name`, must not be `None`") # noqa: E501 self._name = name @property def provider(self): """Gets the provider of this SendingConnectionDto. # noqa: E501 :return: The provider of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._provider @provider.setter def provider(self, provider): """Sets the provider of this SendingConnectionDto. :param provider: The provider of this SendingConnectionDto. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and provider is None: # noqa: E501 raise ValueError("Invalid value for `provider`, must not be `None`") # noqa: E501 allowed_values = ["SMTP", "AMAZON_SES", "SENDGRID", "RESEND", "MAILGUN", "POSTMARK"] # noqa: E501 if self.local_vars_configuration.client_side_validation and provider not in allowed_values: # noqa: E501 raise ValueError( "Invalid value for `provider` ({0}), must be one of {1}" # noqa: E501 .format(provider, allowed_values) ) self._provider = provider @property def provider_preset(self): """Gets the provider_preset of this SendingConnectionDto. # noqa: E501 :return: The provider_preset of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._provider_preset @provider_preset.setter def provider_preset(self, provider_preset): """Sets the provider_preset of this SendingConnectionDto. :param provider_preset: The provider_preset of this SendingConnectionDto. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and provider_preset is None: # noqa: E501 raise ValueError("Invalid value for `provider_preset`, must not be `None`") # noqa: E501 allowed_values = ["GENERIC_SMTP", "GMAIL", "GOOGLE_WORKSPACE", "MICROSOFT_365", "OUTLOOK_COM", "YAHOO_MAIL", "APPLE_ICLOUD", "FASTMAIL", "ZOHO_MAIL", "AOL_MAIL", "GMX_MAIL", "MAIL_COM", "PROTON_MAIL", "AMAZON_SES", "SENDGRID", "RESEND", "MAILGUN", "POSTMARK", "BREVO", "MAILJET", "SPARKPOST", "SMTP2GO", "SENDPULSE", "SOCKETLABS", "MAILERSEND", "MANDRILL", "ELASTIC_EMAIL"] # noqa: E501 if self.local_vars_configuration.client_side_validation and provider_preset not in allowed_values: # noqa: E501 raise ValueError( "Invalid value for `provider_preset` ({0}), must be one of {1}" # noqa: E501 .format(provider_preset, allowed_values) ) self._provider_preset = provider_preset @property def capabilities(self): """Gets the capabilities of this SendingConnectionDto. # noqa: E501 :return: The capabilities of this SendingConnectionDto. # noqa: E501 :rtype: list[str] """ return self._capabilities @capabilities.setter def capabilities(self, capabilities): """Sets the capabilities of this SendingConnectionDto. :param capabilities: The capabilities of this SendingConnectionDto. # noqa: E501 :type: list[str] """ if self.local_vars_configuration.client_side_validation and capabilities is None: # noqa: E501 raise ValueError("Invalid value for `capabilities`, must not be `None`") # noqa: E501 allowed_values = ["SEND_EMAIL", "VERIFY_CONNECTION", "ROTATE_CREDENTIALS", "DELIVERY_PROBE"] # noqa: E501 if (self.local_vars_configuration.client_side_validation and not set(capabilities).issubset(set(allowed_values))): # noqa: E501 raise ValueError( "Invalid values for `capabilities` [{0}], must be a subset of [{1}]" # noqa: E501 .format(", ".join(map(str, set(capabilities) - set(allowed_values))), # noqa: E501 ", ".join(map(str, allowed_values))) ) self._capabilities = capabilities @property def from_email(self): """Gets the from_email of this SendingConnectionDto. # noqa: E501 :return: The from_email of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._from_email @from_email.setter def from_email(self, from_email): """Sets the from_email of this SendingConnectionDto. :param from_email: The from_email of this SendingConnectionDto. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and from_email is None: # noqa: E501 raise ValueError("Invalid value for `from_email`, must not be `None`") # noqa: E501 self._from_email = from_email @property def smtp_host(self): """Gets the smtp_host of this SendingConnectionDto. # noqa: E501 :return: The smtp_host of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._smtp_host @smtp_host.setter def smtp_host(self, smtp_host): """Sets the smtp_host of this SendingConnectionDto. :param smtp_host: The smtp_host of this SendingConnectionDto. # noqa: E501 :type: str """ self._smtp_host = smtp_host @property def smtp_port(self): """Gets the smtp_port of this SendingConnectionDto. # noqa: E501 :return: The smtp_port of this SendingConnectionDto. # noqa: E501 :rtype: int """ return self._smtp_port @smtp_port.setter def smtp_port(self, smtp_port): """Sets the smtp_port of this SendingConnectionDto. :param smtp_port: The smtp_port of this SendingConnectionDto. # noqa: E501 :type: int """ self._smtp_port = smtp_port @property def smtp_security(self): """Gets the smtp_security of this SendingConnectionDto. # noqa: E501 :return: The smtp_security of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._smtp_security @smtp_security.setter def smtp_security(self, smtp_security): """Sets the smtp_security of this SendingConnectionDto. :param smtp_security: The smtp_security of this SendingConnectionDto. # noqa: E501 :type: str """ allowed_values = [None,"START_TLS", "TLS"] # noqa: E501 if self.local_vars_configuration.client_side_validation and smtp_security not in allowed_values: # noqa: E501 raise ValueError( "Invalid value for `smtp_security` ({0}), must be one of {1}" # noqa: E501 .format(smtp_security, allowed_values) ) self._smtp_security = smtp_security @property def username_hint(self): """Gets the username_hint of this SendingConnectionDto. # noqa: E501 :return: The username_hint of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._username_hint @username_hint.setter def username_hint(self, username_hint): """Sets the username_hint of this SendingConnectionDto. :param username_hint: The username_hint of this SendingConnectionDto. # noqa: E501 :type: str """ self._username_hint = username_hint @property def api_region(self): """Gets the api_region of this SendingConnectionDto. # noqa: E501 :return: The api_region of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._api_region @api_region.setter def api_region(self, api_region): """Sets the api_region of this SendingConnectionDto. :param api_region: The api_region of this SendingConnectionDto. # noqa: E501 :type: str """ allowed_values = [None,"US", "EU"] # noqa: E501 if self.local_vars_configuration.client_side_validation and api_region not in allowed_values: # noqa: E501 raise ValueError( "Invalid value for `api_region` ({0}), must be one of {1}" # noqa: E501 .format(api_region, allowed_values) ) self._api_region = api_region @property def sending_domain(self): """Gets the sending_domain of this SendingConnectionDto. # noqa: E501 :return: The sending_domain of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._sending_domain @sending_domain.setter def sending_domain(self, sending_domain): """Sets the sending_domain of this SendingConnectionDto. :param sending_domain: The sending_domain of this SendingConnectionDto. # noqa: E501 :type: str """ self._sending_domain = sending_domain @property def status(self): """Gets the status of this SendingConnectionDto. # noqa: E501 :return: The status of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._status @status.setter def status(self, status): """Sets the status of this SendingConnectionDto. :param status: The status of this SendingConnectionDto. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and status is None: # noqa: E501 raise ValueError("Invalid value for `status`, must not be `None`") # noqa: E501 allowed_values = ["UNVERIFIED", "CONNECTED", "ERROR", "DISCONNECTED"] # noqa: E501 if self.local_vars_configuration.client_side_validation and status not in allowed_values: # noqa: E501 raise ValueError( "Invalid value for `status` ({0}), must be one of {1}" # noqa: E501 .format(status, allowed_values) ) self._status = status @property def enabled(self): """Gets the enabled of this SendingConnectionDto. # noqa: E501 :return: The enabled of this SendingConnectionDto. # noqa: E501 :rtype: bool """ return self._enabled @enabled.setter def enabled(self, enabled): """Sets the enabled of this SendingConnectionDto. :param enabled: The enabled of this SendingConnectionDto. # noqa: E501 :type: bool """ if self.local_vars_configuration.client_side_validation and enabled is None: # noqa: E501 raise ValueError("Invalid value for `enabled`, must not be `None`") # noqa: E501 self._enabled = enabled @property def last_verified_at(self): """Gets the last_verified_at of this SendingConnectionDto. # noqa: E501 :return: The last_verified_at of this SendingConnectionDto. # noqa: E501 :rtype: datetime """ return self._last_verified_at @last_verified_at.setter def last_verified_at(self, last_verified_at): """Sets the last_verified_at of this SendingConnectionDto. :param last_verified_at: The last_verified_at of this SendingConnectionDto. # noqa: E501 :type: datetime """ self._last_verified_at = last_verified_at @property def last_error_code(self): """Gets the last_error_code of this SendingConnectionDto. # noqa: E501 :return: The last_error_code of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._last_error_code @last_error_code.setter def last_error_code(self, last_error_code): """Sets the last_error_code of this SendingConnectionDto. :param last_error_code: The last_error_code of this SendingConnectionDto. # noqa: E501 :type: str """ self._last_error_code = last_error_code @property def created_at(self): """Gets the created_at of this SendingConnectionDto. # noqa: E501 :return: The created_at of this SendingConnectionDto. # noqa: E501 :rtype: datetime """ return self._created_at @created_at.setter def created_at(self, created_at): """Sets the created_at of this SendingConnectionDto. :param created_at: The created_at of this SendingConnectionDto. # noqa: E501 :type: datetime """ if self.local_vars_configuration.client_side_validation and created_at is None: # noqa: E501 raise ValueError("Invalid value for `created_at`, must not be `None`") # noqa: E501 self._created_at = created_at @property def updated_at(self): """Gets the updated_at of this SendingConnectionDto. # noqa: E501 :return: The updated_at of this SendingConnectionDto. # noqa: E501 :rtype: datetime """ return self._updated_at @updated_at.setter def updated_at(self, updated_at): """Sets the updated_at of this SendingConnectionDto. :param updated_at: The updated_at of this SendingConnectionDto. # noqa: E501 :type: datetime """ if self.local_vars_configuration.client_side_validation and updated_at is None: # noqa: E501 raise ValueError("Invalid value for `updated_at`, must not be `None`") # noqa: E501 self._updated_at = updated_at 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, SendingConnectionDto): 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, SendingConnectionDto): return True return self.to_dict() != other.to_dict()Class variables
var attribute_mapvar openapi_types
Instance variables
prop api_region-
Gets the api_region of this SendingConnectionDto. # noqa: E501
:return: The api_region of this SendingConnectionDto. # noqa: E501 :rtype: str
Expand source code
@property def api_region(self): """Gets the api_region of this SendingConnectionDto. # noqa: E501 :return: The api_region of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._api_region prop capabilities-
Gets the capabilities of this SendingConnectionDto. # noqa: E501
:return: The capabilities of this SendingConnectionDto. # noqa: E501 :rtype: list[str]
Expand source code
@property def capabilities(self): """Gets the capabilities of this SendingConnectionDto. # noqa: E501 :return: The capabilities of this SendingConnectionDto. # noqa: E501 :rtype: list[str] """ return self._capabilities prop created_at-
Gets the created_at of this SendingConnectionDto. # noqa: E501
:return: The created_at of this SendingConnectionDto. # noqa: E501 :rtype: datetime
Expand source code
@property def created_at(self): """Gets the created_at of this SendingConnectionDto. # noqa: E501 :return: The created_at of this SendingConnectionDto. # noqa: E501 :rtype: datetime """ return self._created_at prop enabled-
Gets the enabled of this SendingConnectionDto. # noqa: E501
:return: The enabled of this SendingConnectionDto. # noqa: E501 :rtype: bool
Expand source code
@property def enabled(self): """Gets the enabled of this SendingConnectionDto. # noqa: E501 :return: The enabled of this SendingConnectionDto. # noqa: E501 :rtype: bool """ return self._enabled prop from_email-
Gets the from_email of this SendingConnectionDto. # noqa: E501
:return: The from_email of this SendingConnectionDto. # noqa: E501 :rtype: str
Expand source code
@property def from_email(self): """Gets the from_email of this SendingConnectionDto. # noqa: E501 :return: The from_email of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._from_email prop id-
Gets the id of this SendingConnectionDto. # noqa: E501
:return: The id of this SendingConnectionDto. # noqa: E501 :rtype: str
Expand source code
@property def id(self): """Gets the id of this SendingConnectionDto. # noqa: E501 :return: The id of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._id prop last_error_code-
Gets the last_error_code of this SendingConnectionDto. # noqa: E501
:return: The last_error_code of this SendingConnectionDto. # noqa: E501 :rtype: str
Expand source code
@property def last_error_code(self): """Gets the last_error_code of this SendingConnectionDto. # noqa: E501 :return: The last_error_code of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._last_error_code prop last_verified_at-
Gets the last_verified_at of this SendingConnectionDto. # noqa: E501
:return: The last_verified_at of this SendingConnectionDto. # noqa: E501 :rtype: datetime
Expand source code
@property def last_verified_at(self): """Gets the last_verified_at of this SendingConnectionDto. # noqa: E501 :return: The last_verified_at of this SendingConnectionDto. # noqa: E501 :rtype: datetime """ return self._last_verified_at prop name-
Gets the name of this SendingConnectionDto. # noqa: E501
:return: The name of this SendingConnectionDto. # noqa: E501 :rtype: str
Expand source code
@property def name(self): """Gets the name of this SendingConnectionDto. # noqa: E501 :return: The name of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._name prop provider-
Gets the provider of this SendingConnectionDto. # noqa: E501
:return: The provider of this SendingConnectionDto. # noqa: E501 :rtype: str
Expand source code
@property def provider(self): """Gets the provider of this SendingConnectionDto. # noqa: E501 :return: The provider of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._provider prop provider_preset-
Gets the provider_preset of this SendingConnectionDto. # noqa: E501
:return: The provider_preset of this SendingConnectionDto. # noqa: E501 :rtype: str
Expand source code
@property def provider_preset(self): """Gets the provider_preset of this SendingConnectionDto. # noqa: E501 :return: The provider_preset of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._provider_preset prop sending_domain-
Gets the sending_domain of this SendingConnectionDto. # noqa: E501
:return: The sending_domain of this SendingConnectionDto. # noqa: E501 :rtype: str
Expand source code
@property def sending_domain(self): """Gets the sending_domain of this SendingConnectionDto. # noqa: E501 :return: The sending_domain of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._sending_domain prop smtp_host-
Gets the smtp_host of this SendingConnectionDto. # noqa: E501
:return: The smtp_host of this SendingConnectionDto. # noqa: E501 :rtype: str
Expand source code
@property def smtp_host(self): """Gets the smtp_host of this SendingConnectionDto. # noqa: E501 :return: The smtp_host of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._smtp_host prop smtp_port-
Gets the smtp_port of this SendingConnectionDto. # noqa: E501
:return: The smtp_port of this SendingConnectionDto. # noqa: E501 :rtype: int
Expand source code
@property def smtp_port(self): """Gets the smtp_port of this SendingConnectionDto. # noqa: E501 :return: The smtp_port of this SendingConnectionDto. # noqa: E501 :rtype: int """ return self._smtp_port prop smtp_security-
Gets the smtp_security of this SendingConnectionDto. # noqa: E501
:return: The smtp_security of this SendingConnectionDto. # noqa: E501 :rtype: str
Expand source code
@property def smtp_security(self): """Gets the smtp_security of this SendingConnectionDto. # noqa: E501 :return: The smtp_security of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._smtp_security prop status-
Gets the status of this SendingConnectionDto. # noqa: E501
:return: The status of this SendingConnectionDto. # noqa: E501 :rtype: str
Expand source code
@property def status(self): """Gets the status of this SendingConnectionDto. # noqa: E501 :return: The status of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._status prop updated_at-
Gets the updated_at of this SendingConnectionDto. # noqa: E501
:return: The updated_at of this SendingConnectionDto. # noqa: E501 :rtype: datetime
Expand source code
@property def updated_at(self): """Gets the updated_at of this SendingConnectionDto. # noqa: E501 :return: The updated_at of this SendingConnectionDto. # noqa: E501 :rtype: datetime """ return self._updated_at prop username_hint-
Gets the username_hint of this SendingConnectionDto. # noqa: E501
:return: The username_hint of this SendingConnectionDto. # noqa: E501 :rtype: str
Expand source code
@property def username_hint(self): """Gets the username_hint of this SendingConnectionDto. # noqa: E501 :return: The username_hint of this SendingConnectionDto. # noqa: E501 :rtype: str """ return self._username_hint
Methods
def to_dict(self)-
Returns the model properties as a dict
def to_str(self)-
Returns the string representation of the model