Module mailslurp_client.models.create_sending_connection_options

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 CreateSendingConnectionOptions (name=None, provider_preset=None, provider=None, from_email=None, smtp=None, api_key=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.

CreateSendingConnectionOptions - a model defined in OpenAPI

Expand source code

class CreateSendingConnectionOptions(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',
        'provider_preset': 'str',
        'provider': 'str',
        'from_email': 'str',
        'smtp': 'SendingConnectionSmtpOptions',
        'api_key': 'SendingConnectionApiKeyOptions'
    }

    attribute_map = {
        'name': 'name',
        'provider_preset': 'providerPreset',
        'provider': 'provider',
        'from_email': 'fromEmail',
        'smtp': 'smtp',
        'api_key': 'apiKey'
    }

    def __init__(self, name=None, provider_preset=None, provider=None, from_email=None, smtp=None, api_key=None, local_vars_configuration=None):  # noqa: E501
        """CreateSendingConnectionOptions - 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._provider_preset = None
        self._provider = None
        self._from_email = None
        self._smtp = None
        self._api_key = None
        self.discriminator = None

        self.name = name
        self.provider_preset = provider_preset
        self.provider = provider
        self.from_email = from_email
        self.smtp = smtp
        self.api_key = api_key

    @property
    def name(self):
        """Gets the name of this CreateSendingConnectionOptions.  # noqa: E501


        :return: The name of this CreateSendingConnectionOptions.  # noqa: E501
        :rtype: str
        """
        return self._name

    @name.setter
    def name(self, name):
        """Sets the name of this CreateSendingConnectionOptions.


        :param name: The name of this CreateSendingConnectionOptions.  # 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
        if (self.local_vars_configuration.client_side_validation and
                name is not None and len(name) > 255):
            raise ValueError("Invalid value for `name`, length must be less than or equal to `255`")  # noqa: E501
        if (self.local_vars_configuration.client_side_validation and
                name is not None and len(name) < 0):
            raise ValueError("Invalid value for `name`, length must be greater than or equal to `0`")  # noqa: E501

        self._name = name

    @property
    def provider_preset(self):
        """Gets the provider_preset of this CreateSendingConnectionOptions.  # noqa: E501


        :return: The provider_preset of this CreateSendingConnectionOptions.  # noqa: E501
        :rtype: str
        """
        return self._provider_preset

    @provider_preset.setter
    def provider_preset(self, provider_preset):
        """Sets the provider_preset of this CreateSendingConnectionOptions.


        :param provider_preset: The provider_preset of this CreateSendingConnectionOptions.  # 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 provider(self):
        """Gets the provider of this CreateSendingConnectionOptions.  # noqa: E501


        :return: The provider of this CreateSendingConnectionOptions.  # noqa: E501
        :rtype: str
        """
        return self._provider

    @provider.setter
    def provider(self, provider):
        """Sets the provider of this CreateSendingConnectionOptions.


        :param provider: The provider of this CreateSendingConnectionOptions.  # 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 from_email(self):
        """Gets the from_email of this CreateSendingConnectionOptions.  # noqa: E501


        :return: The from_email of this CreateSendingConnectionOptions.  # noqa: E501
        :rtype: str
        """
        return self._from_email

    @from_email.setter
    def from_email(self, from_email):
        """Sets the from_email of this CreateSendingConnectionOptions.


        :param from_email: The from_email of this CreateSendingConnectionOptions.  # 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
        if (self.local_vars_configuration.client_side_validation and
                from_email is not None and len(from_email) > 320):
            raise ValueError("Invalid value for `from_email`, length must be less than or equal to `320`")  # noqa: E501
        if (self.local_vars_configuration.client_side_validation and
                from_email is not None and len(from_email) < 0):
            raise ValueError("Invalid value for `from_email`, length must be greater than or equal to `0`")  # noqa: E501

        self._from_email = from_email

    @property
    def smtp(self):
        """Gets the smtp of this CreateSendingConnectionOptions.  # noqa: E501


        :return: The smtp of this CreateSendingConnectionOptions.  # noqa: E501
        :rtype: SendingConnectionSmtpOptions
        """
        return self._smtp

    @smtp.setter
    def smtp(self, smtp):
        """Sets the smtp of this CreateSendingConnectionOptions.


        :param smtp: The smtp of this CreateSendingConnectionOptions.  # noqa: E501
        :type: SendingConnectionSmtpOptions
        """

        self._smtp = smtp

    @property
    def api_key(self):
        """Gets the api_key of this CreateSendingConnectionOptions.  # noqa: E501


        :return: The api_key of this CreateSendingConnectionOptions.  # noqa: E501
        :rtype: SendingConnectionApiKeyOptions
        """
        return self._api_key

    @api_key.setter
    def api_key(self, api_key):
        """Sets the api_key of this CreateSendingConnectionOptions.


        :param api_key: The api_key of this CreateSendingConnectionOptions.  # noqa: E501
        :type: SendingConnectionApiKeyOptions
        """

        self._api_key = api_key

    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, CreateSendingConnectionOptions):
            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, CreateSendingConnectionOptions):
            return True

        return self.to_dict() != other.to_dict()

Class variables

var attribute_map

var openapi_types

Instance variables

prop api_key

Gets the api_key of this CreateSendingConnectionOptions. # noqa: E501

:return: The api_key of this CreateSendingConnectionOptions. # noqa: E501 :rtype: SendingConnectionApiKeyOptions

Expand source code

@property
def api_key(self):
    """Gets the api_key of this CreateSendingConnectionOptions.  # noqa: E501


    :return: The api_key of this CreateSendingConnectionOptions.  # noqa: E501
    :rtype: SendingConnectionApiKeyOptions
    """
    return self._api_key

prop from_email

Gets the from_email of this CreateSendingConnectionOptions. # noqa: E501

:return: The from_email of this CreateSendingConnectionOptions. # noqa: E501 :rtype: str

Expand source code

@property
def from_email(self):
    """Gets the from_email of this CreateSendingConnectionOptions.  # noqa: E501


    :return: The from_email of this CreateSendingConnectionOptions.  # noqa: E501
    :rtype: str
    """
    return self._from_email

prop name

Gets the name of this CreateSendingConnectionOptions. # noqa: E501

:return: The name of this CreateSendingConnectionOptions. # noqa: E501 :rtype: str

Expand source code

@property
def name(self):
    """Gets the name of this CreateSendingConnectionOptions.  # noqa: E501


    :return: The name of this CreateSendingConnectionOptions.  # noqa: E501
    :rtype: str
    """
    return self._name

prop provider

Gets the provider of this CreateSendingConnectionOptions. # noqa: E501

:return: The provider of this CreateSendingConnectionOptions. # noqa: E501 :rtype: str

Expand source code

@property
def provider(self):
    """Gets the provider of this CreateSendingConnectionOptions.  # noqa: E501


    :return: The provider of this CreateSendingConnectionOptions.  # noqa: E501
    :rtype: str
    """
    return self._provider

prop provider_preset

Gets the provider_preset of this CreateSendingConnectionOptions. # noqa: E501

:return: The provider_preset of this CreateSendingConnectionOptions. # noqa: E501 :rtype: str

Expand source code

@property
def provider_preset(self):
    """Gets the provider_preset of this CreateSendingConnectionOptions.  # noqa: E501


    :return: The provider_preset of this CreateSendingConnectionOptions.  # noqa: E501
    :rtype: str
    """
    return self._provider_preset

prop smtp

Gets the smtp of this CreateSendingConnectionOptions. # noqa: E501

:return: The smtp of this CreateSendingConnectionOptions. # noqa: E501 :rtype: SendingConnectionSmtpOptions

Expand source code

@property
def smtp(self):
    """Gets the smtp of this CreateSendingConnectionOptions.  # noqa: E501


    :return: The smtp of this CreateSendingConnectionOptions.  # noqa: E501
    :rtype: SendingConnectionSmtpOptions
    """
    return self._smtp

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model