Documentation

ConnectorSmtpConnectionDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

ConnectorSmtpConnectionDto Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

\ArrayAccess<string, mixed>

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Table of Contents

DISCRIMINATOR  = null
$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
getConnectorId()  : string
Gets connector_id
getCreatedAt()  : DateTime
Gets created_at
getEnabled()  : bool|null
Gets enabled
getId()  : string
Gets id
getLocalHostName()  : string|null
Gets local_host_name
getModelName()  : string
The original name of the model.
getProxyEnabled()  : bool|null
Gets proxy_enabled
getProxyHost()  : string|null
Gets proxy_host
getProxyPort()  : int|null
Gets proxy_port
getSmtpHost()  : string
Gets smtp_host
getSmtpMechanisms()  : array<string|int, string>|null
Gets smtp_mechanisms
getSmtpPassword()  : string|null
Gets smtp_password
getSmtpPort()  : int|null
Gets smtp_port
getSmtpSsl()  : bool|null
Gets smtp_ssl
getSmtpUsername()  : string|null
Gets smtp_username
getSslProtocols()  : array<string|int, string>|null
Gets ssl_protocols
getSslTrust()  : string|null
Gets ssl_trust
getStartTls()  : bool|null
Gets start_tls
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
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
setConnectorId()  : self
Sets connector_id
setCreatedAt()  : self
Sets created_at
setEnabled()  : self
Sets enabled
setId()  : self
Sets id
setLocalHostName()  : self
Sets local_host_name
setProxyEnabled()  : self
Sets proxy_enabled
setProxyHost()  : self
Sets proxy_host
setProxyPort()  : self
Sets proxy_port
setSmtpHost()  : self
Sets smtp_host
setSmtpMechanisms()  : self
Sets smtp_mechanisms
setSmtpPassword()  : self
Sets smtp_password
setSmtpPort()  : self
Sets smtp_port
setSmtpSsl()  : self
Sets smtp_ssl
setSmtpUsername()  : self
Sets smtp_username
setSslProtocols()  : self
Sets ssl_protocols
setSslTrust()  : self
Sets ssl_trust
setStartTls()  : self
Sets start_tls
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
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

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 = ['connector_id' => 'connectorId', 'smtp_host' => 'smtpHost', 'smtp_port' => 'smtpPort', 'smtp_username' => 'smtpUsername', 'smtp_password' => 'smtpPassword', 'smtp_ssl' => 'smtpSsl', 'start_tls' => 'startTls', 'smtp_mechanisms' => 'smtpMechanisms', 'local_host_name' => 'localHostName', 'proxy_host' => 'proxyHost', 'proxy_port' => 'proxyPort', 'proxy_enabled' => 'proxyEnabled', 'enabled' => 'enabled', 'ssl_trust' => 'sslTrust', 'ssl_protocols' => 'sslProtocols', 'created_at' => 'createdAt', 'id' => 'id']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['connector_id' => 'getConnectorId', 'smtp_host' => 'getSmtpHost', 'smtp_port' => 'getSmtpPort', 'smtp_username' => 'getSmtpUsername', 'smtp_password' => 'getSmtpPassword', 'smtp_ssl' => 'getSmtpSsl', 'start_tls' => 'getStartTls', 'smtp_mechanisms' => 'getSmtpMechanisms', 'local_host_name' => 'getLocalHostName', 'proxy_host' => 'getProxyHost', 'proxy_port' => 'getProxyPort', 'proxy_enabled' => 'getProxyEnabled', 'enabled' => 'getEnabled', 'ssl_trust' => 'getSslTrust', 'ssl_protocols' => 'getSslProtocols', 'created_at' => 'getCreatedAt', 'id' => 'getId']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $openAPIFormats = ['connector_id' => 'uuid', 'smtp_host' => null, 'smtp_port' => 'int32', 'smtp_username' => null, 'smtp_password' => null, 'smtp_ssl' => null, 'start_tls' => null, 'smtp_mechanisms' => null, 'local_host_name' => null, 'proxy_host' => null, 'proxy_port' => 'int32', 'proxy_enabled' => null, 'enabled' => null, 'ssl_trust' => null, 'ssl_protocols' => null, 'created_at' => 'date-time', 'id' => 'uuid']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'ConnectorSmtpConnectionDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['connector_id' => false, 'smtp_host' => false, 'smtp_port' => true, 'smtp_username' => true, 'smtp_password' => true, 'smtp_ssl' => true, 'start_tls' => true, 'smtp_mechanisms' => true, 'local_host_name' => true, 'proxy_host' => true, 'proxy_port' => true, 'proxy_enabled' => true, 'enabled' => true, 'ssl_trust' => true, 'ssl_protocols' => true, 'created_at' => false, 'id' => false]

$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 = ['connector_id' => 'string', 'smtp_host' => 'string', 'smtp_port' => 'int', 'smtp_username' => 'string', 'smtp_password' => 'string', 'smtp_ssl' => 'bool', 'start_tls' => 'bool', 'smtp_mechanisms' => 'string[]', 'local_host_name' => 'string', 'proxy_host' => 'string', 'proxy_port' => 'int', 'proxy_enabled' => 'bool', 'enabled' => 'bool', 'ssl_trust' => 'string', 'ssl_protocols' => 'string[]', 'created_at' => '\\DateTime', 'id' => 'string']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['connector_id' => 'setConnectorId', 'smtp_host' => 'setSmtpHost', 'smtp_port' => 'setSmtpPort', 'smtp_username' => 'setSmtpUsername', 'smtp_password' => 'setSmtpPassword', 'smtp_ssl' => 'setSmtpSsl', 'start_tls' => 'setStartTls', 'smtp_mechanisms' => 'setSmtpMechanisms', 'local_host_name' => 'setLocalHostName', 'proxy_host' => 'setProxyHost', 'proxy_port' => 'setProxyPort', 'proxy_enabled' => 'setProxyEnabled', 'enabled' => 'setEnabled', 'ssl_trust' => 'setSslTrust', 'ssl_protocols' => 'setSslProtocols', 'created_at' => 'setCreatedAt', 'id' => 'setId']

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 —

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> —

getSmtpMechanisms()

Gets smtp_mechanisms

public getSmtpMechanisms() : array<string|int, string>|null
Return values
array<string|int, string>|null —

getSslProtocols()

Gets ssl_protocols

public getSslProtocols() : array<string|int, string>|null
Return values
array<string|int, string>|null —

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

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 —

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> —

setConnectorId()

Sets connector_id

public setConnectorId(string $connector_id) : self
Parameters
$connector_id : string

connector_id

Return values
self —

setCreatedAt()

Sets created_at

public setCreatedAt(DateTime $created_at) : self
Parameters
$created_at : DateTime

created_at

Return values
self —

setEnabled()

Sets enabled

public setEnabled(bool|null $enabled) : self
Parameters
$enabled : bool|null

enabled

Return values
self —

setLocalHostName()

Sets local_host_name

public setLocalHostName(string|null $local_host_name) : self
Parameters
$local_host_name : string|null

local_host_name

Return values
self —

setProxyEnabled()

Sets proxy_enabled

public setProxyEnabled(bool|null $proxy_enabled) : self
Parameters
$proxy_enabled : bool|null

proxy_enabled

Return values
self —

setProxyHost()

Sets proxy_host

public setProxyHost(string|null $proxy_host) : self
Parameters
$proxy_host : string|null

proxy_host

Return values
self —

setProxyPort()

Sets proxy_port

public setProxyPort(int|null $proxy_port) : self
Parameters
$proxy_port : int|null

proxy_port

Return values
self —

setSmtpHost()

Sets smtp_host

public setSmtpHost(string $smtp_host) : self
Parameters
$smtp_host : string

smtp_host

Return values
self —

setSmtpMechanisms()

Sets smtp_mechanisms

public setSmtpMechanisms(array<string|int, string>|null $smtp_mechanisms) : self
Parameters
$smtp_mechanisms : array<string|int, string>|null

smtp_mechanisms

Return values
self —

setSmtpPassword()

Sets smtp_password

public setSmtpPassword(string|null $smtp_password) : self
Parameters
$smtp_password : string|null

smtp_password

Return values
self —

setSmtpPort()

Sets smtp_port

public setSmtpPort(int|null $smtp_port) : self
Parameters
$smtp_port : int|null

smtp_port

Return values
self —

setSmtpSsl()

Sets smtp_ssl

public setSmtpSsl(bool|null $smtp_ssl) : self
Parameters
$smtp_ssl : bool|null

smtp_ssl

Return values
self —

setSmtpUsername()

Sets smtp_username

public setSmtpUsername(string|null $smtp_username) : self
Parameters
$smtp_username : string|null

smtp_username

Return values
self —

setSslProtocols()

Sets ssl_protocols

public setSslProtocols(array<string|int, string>|null $ssl_protocols) : self
Parameters
$ssl_protocols : array<string|int, string>|null

ssl_protocols

Return values
self —

setSslTrust()

Sets ssl_trust

public setSslTrust(string|null $ssl_trust) : self
Parameters
$ssl_trust : string|null

ssl_trust

Return values
self —

setStartTls()

Sets start_tls

public setStartTls(bool|null $start_tls) : self
Parameters
$start_tls : bool|null

start_tls

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> —

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>
Return values
void —

Search results