SendingConnectionProviderDtoSmtpDefaults
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
SendingConnectionProviderDtoSmtpDefaults Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- RECOMMENDED_SECURITY_START_TLS = 'START_TLS'
- RECOMMENDED_SECURITY_TLS = 'TLS'
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $openAPIFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $openAPIModelName : string
- The original name of the model.
- $openAPINullables : array<string|int, mixed>
- Array of nullable properties. Used for (de)serialization
- $openAPINullablesSetToNull : array<string|int, mixed>
- If a nullable field gets set to null, insert it here
- $openAPITypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getDefaultUsername() : string|null
- Gets default_username
- getHost() : string|null
- Gets host
- getHostOptions() : array<string|int, SendingConnectionSmtpHostOption>
- Gets host_options
- getModelName() : string
- The original name of the model.
- getPasswordHint() : string|null
- Gets password_hint
- getPorts() : array<string|int, int>
- Gets ports
- getRecommendedPort() : int|null
- Gets recommended_port
- getRecommendedSecurity() : string|null
- Gets recommended_security
- getRecommendedSecurityAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUsernameHint() : string|null
- Gets username_hint
- isNullable() : bool
- Checks if a property is nullable
- isNullableSetToNull() : bool
- Checks if a nullable property is set to null.
- jsonSerialize() : mixed
- Serializes the object to a value that can be serialized natively by json_encode().
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed|null
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- openAPIFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- openAPITypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- setDefaultUsername() : self
- Sets default_username
- setHost() : self
- Sets host
- setHostOptions() : self
- Sets host_options
- setPasswordHint() : self
- Sets password_hint
- setPorts() : self
- Sets ports
- setRecommendedPort() : self
- Sets recommended_port
- setRecommendedSecurity() : self
- Sets recommended_security
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUsernameHint() : self
- Sets username_hint
- toHeaderValue() : string
- Gets a header-safe presentation of the object
- valid() : bool
- Validate all the properties in the model return true if all passed
- openAPINullables() : array<string|int, mixed>
- Array of nullable properties
- getOpenAPINullablesSetToNull() : array<string|int, bool>
- Array of nullable field names deliberately set to null
- setIfExists() : void
- Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
- setOpenAPINullablesSetToNull() : void
- Setter - Array of nullable field names deliberately set to null
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
RECOMMENDED_SECURITY_START_TLS
public
mixed
RECOMMENDED_SECURITY_START_TLS
= 'START_TLS'
RECOMMENDED_SECURITY_TLS
public
mixed
RECOMMENDED_SECURITY_TLS
= 'TLS'
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['host' => 'host', 'host_options' => 'hostOptions', 'ports' => 'ports', 'recommended_port' => 'recommendedPort', 'recommended_security' => 'recommendedSecurity', 'default_username' => 'defaultUsername', 'username_hint' => 'usernameHint', 'password_hint' => 'passwordHint']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['host' => 'getHost', 'host_options' => 'getHostOptions', 'ports' => 'getPorts', 'recommended_port' => 'getRecommendedPort', 'recommended_security' => 'getRecommendedSecurity', 'default_username' => 'getDefaultUsername', 'username_hint' => 'getUsernameHint', 'password_hint' => 'getPasswordHint']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['host' => null, 'host_options' => null, 'ports' => 'int32', 'recommended_port' => 'int32', 'recommended_security' => null, 'default_username' => null, 'username_hint' => null, 'password_hint' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'SendingConnectionProviderDto_smtpDefaults'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['host' => true, 'host_options' => false, 'ports' => false, 'recommended_port' => true, 'recommended_security' => true, 'default_username' => true, 'username_hint' => true, 'password_hint' => true]
$openAPINullablesSetToNull
If a nullable field gets set to null, insert it here
protected
array<string|int, mixed>
$openAPINullablesSetToNull
= []
$openAPITypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPITypes
= ['host' => 'string', 'host_options' => '\\MailSlurp\\Models\\SendingConnectionSmtpHostOption[]', 'ports' => 'int[]', 'recommended_port' => 'int', 'recommended_security' => 'string', 'default_username' => 'string', 'username_hint' => 'string', 'password_hint' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['host' => 'setHost', 'host_options' => 'setHostOptions', 'ports' => 'setPorts', 'recommended_port' => 'setRecommendedPort', 'recommended_security' => 'setRecommendedSecurity', 'default_username' => 'setDefaultUsername', 'username_hint' => 'setUsernameHint', 'password_hint' => 'setPasswordHint']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDefaultUsername()
Gets default_username
public
getDefaultUsername() : string|null
Return values
string|null —getHost()
Gets host
public
getHost() : string|null
Return values
string|null —getHostOptions()
Gets host_options
public
getHostOptions() : array<string|int, SendingConnectionSmtpHostOption>
Return values
array<string|int, SendingConnectionSmtpHostOption> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPasswordHint()
Gets password_hint
public
getPasswordHint() : string|null
Return values
string|null —getPorts()
Gets ports
public
getPorts() : array<string|int, int>
Return values
array<string|int, int> —getRecommendedPort()
Gets recommended_port
public
getRecommendedPort() : int|null
Return values
int|null —getRecommendedSecurity()
Gets recommended_security
public
getRecommendedSecurity() : string|null
Return values
string|null —getRecommendedSecurityAllowableValues()
Gets allowable values of the enum
public
getRecommendedSecurityAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUsernameHint()
Gets username_hint
public
getUsernameHint() : string|null
Return values
string|null —isNullable()
Checks if a property is nullable
public
static isNullable(string $property) : bool
Parameters
- $property : string
Return values
bool —isNullableSetToNull()
Checks if a nullable property is set to null.
public
isNullableSetToNull(string $property) : bool
Parameters
- $property : string
Return values
bool —jsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
Return values
mixed —Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.
listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed|null
Parameters
- $offset : int
-
Offset
Return values
mixed|null —offsetSet()
Sets value based on offset.
public
offsetSet(int|null $offset, mixed $value) : void
Parameters
- $offset : int|null
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —openAPIFormats()
Array of property to format mappings. Used for (de)serialization
public
static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —openAPITypes()
Array of property to type mappings. Used for (de)serialization
public
static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —setDefaultUsername()
Sets default_username
public
setDefaultUsername(string|null $default_username) : self
Parameters
- $default_username : string|null
-
default_username
Return values
self —setHost()
Sets host
public
setHost(string|null $host) : self
Parameters
- $host : string|null
-
host
Return values
self —setHostOptions()
Sets host_options
public
setHostOptions(array<string|int, SendingConnectionSmtpHostOption> $host_options) : self
Parameters
- $host_options : array<string|int, SendingConnectionSmtpHostOption>
-
host_options
Return values
self —setPasswordHint()
Sets password_hint
public
setPasswordHint(string|null $password_hint) : self
Parameters
- $password_hint : string|null
-
password_hint
Return values
self —setPorts()
Sets ports
public
setPorts(array<string|int, int> $ports) : self
Parameters
- $ports : array<string|int, int>
-
ports
Return values
self —setRecommendedPort()
Sets recommended_port
public
setRecommendedPort(int|null $recommended_port) : self
Parameters
- $recommended_port : int|null
-
recommended_port
Return values
self —setRecommendedSecurity()
Sets recommended_security
public
setRecommendedSecurity(string|null $recommended_security) : self
Parameters
- $recommended_security : string|null
-
recommended_security
Return values
self —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —setUsernameHint()
Sets username_hint
public
setUsernameHint(string|null $username_hint) : self
Parameters
- $username_hint : string|null
-
username_hint
Return values
self —toHeaderValue()
Gets a header-safe presentation of the object
public
toHeaderValue() : string
Return values
string —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properties are valid
openAPINullables()
Array of nullable properties
protected
static openAPINullables() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOpenAPINullablesSetToNull()
Array of nullable field names deliberately set to null
private
getOpenAPINullablesSetToNull() : array<string|int, bool>
Return values
array<string|int, bool> —setIfExists()
Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
private
setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
- $variableName : string
- $fields : array<string|int, mixed>
- $defaultValue : mixed
Return values
void —setOpenAPINullablesSetToNull()
Setter - Array of nullable field names deliberately set to null
private
setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void
Parameters
- $openAPINullablesSetToNull : array<string|int, bool>