Documentation

SendingConnectionDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

SendingConnectionDto 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

API_REGION_EU  = 'EU'
API_REGION_US  = 'US'
CAPABILITIES_DELIVERY_PROBE  = 'DELIVERY_PROBE'
CAPABILITIES_ROTATE_CREDENTIALS  = 'ROTATE_CREDENTIALS'
CAPABILITIES_SEND_EMAIL  = 'SEND_EMAIL'
CAPABILITIES_VERIFY_CONNECTION  = 'VERIFY_CONNECTION'
DISCRIMINATOR  = null
PROVIDER_AMAZON_SES  = 'AMAZON_SES'
PROVIDER_MAILGUN  = 'MAILGUN'
PROVIDER_POSTMARK  = 'POSTMARK'
PROVIDER_PRESET_AMAZON_SES  = 'AMAZON_SES'
PROVIDER_PRESET_AOL_MAIL  = 'AOL_MAIL'
PROVIDER_PRESET_APPLE_ICLOUD  = 'APPLE_ICLOUD'
PROVIDER_PRESET_BREVO  = 'BREVO'
PROVIDER_PRESET_ELASTIC_EMAIL  = 'ELASTIC_EMAIL'
PROVIDER_PRESET_FASTMAIL  = 'FASTMAIL'
PROVIDER_PRESET_GENERIC_SMTP  = 'GENERIC_SMTP'
PROVIDER_PRESET_GMAIL  = 'GMAIL'
PROVIDER_PRESET_GMX_MAIL  = 'GMX_MAIL'
PROVIDER_PRESET_GOOGLE_WORKSPACE  = 'GOOGLE_WORKSPACE'
PROVIDER_PRESET_MAIL_COM  = 'MAIL_COM'
PROVIDER_PRESET_MAILERSEND  = 'MAILERSEND'
PROVIDER_PRESET_MAILGUN  = 'MAILGUN'
PROVIDER_PRESET_MAILJET  = 'MAILJET'
PROVIDER_PRESET_MANDRILL  = 'MANDRILL'
PROVIDER_PRESET_MICROSOFT_365  = 'MICROSOFT_365'
PROVIDER_PRESET_OUTLOOK_COM  = 'OUTLOOK_COM'
PROVIDER_PRESET_POSTMARK  = 'POSTMARK'
PROVIDER_PRESET_PROTON_MAIL  = 'PROTON_MAIL'
PROVIDER_PRESET_RESEND  = 'RESEND'
PROVIDER_PRESET_SENDGRID  = 'SENDGRID'
PROVIDER_PRESET_SENDPULSE  = 'SENDPULSE'
PROVIDER_PRESET_SMTP2_GO  = 'SMTP2GO'
PROVIDER_PRESET_SOCKETLABS  = 'SOCKETLABS'
PROVIDER_PRESET_SPARKPOST  = 'SPARKPOST'
PROVIDER_PRESET_YAHOO_MAIL  = 'YAHOO_MAIL'
PROVIDER_PRESET_ZOHO_MAIL  = 'ZOHO_MAIL'
PROVIDER_RESEND  = 'RESEND'
PROVIDER_SENDGRID  = 'SENDGRID'
PROVIDER_SMTP  = 'SMTP'
SMTP_SECURITY_START_TLS  = 'START_TLS'
SMTP_SECURITY_TLS  = 'TLS'
STATUS_CONNECTED  = 'CONNECTED'
STATUS_DISCONNECTED  = 'DISCONNECTED'
STATUS_ERROR  = 'ERROR'
STATUS_UNVERIFIED  = 'UNVERIFIED'
$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
getApiRegion()  : string|null
Gets api_region
getApiRegionAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getCapabilities()  : array<string|int, string>
Gets capabilities
getCapabilitiesAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getCreatedAt()  : DateTime
Gets created_at
getEnabled()  : bool
Gets enabled
getFromEmail()  : string
Gets from_email
getId()  : string
Gets id
getLastErrorCode()  : string|null
Gets last_error_code
getLastVerifiedAt()  : DateTime|null
Gets last_verified_at
getModelName()  : string
The original name of the model.
getName()  : string
Gets name
getProvider()  : string
Gets provider
getProviderAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getProviderPreset()  : string
Gets provider_preset
getProviderPresetAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getSendingDomain()  : string|null
Gets sending_domain
getSmtpHost()  : string|null
Gets smtp_host
getSmtpPort()  : int|null
Gets smtp_port
getSmtpSecurity()  : string|null
Gets smtp_security
getSmtpSecurityAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getStatus()  : string
Gets status
getStatusAllowableValues()  : 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)
getUpdatedAt()  : DateTime
Gets updated_at
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
setApiRegion()  : self
Sets api_region
setCapabilities()  : self
Sets capabilities
setCreatedAt()  : self
Sets created_at
setEnabled()  : self
Sets enabled
setFromEmail()  : self
Sets from_email
setId()  : self
Sets id
setLastErrorCode()  : self
Sets last_error_code
setLastVerifiedAt()  : self
Sets last_verified_at
setName()  : self
Sets name
setProvider()  : self
Sets provider
setProviderPreset()  : self
Sets provider_preset
setSendingDomain()  : self
Sets sending_domain
setSmtpHost()  : self
Sets smtp_host
setSmtpPort()  : self
Sets smtp_port
setSmtpSecurity()  : self
Sets smtp_security
setStatus()  : self
Sets status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUpdatedAt()  : self
Sets updated_at
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

CAPABILITIES_DELIVERY_PROBE

public mixed CAPABILITIES_DELIVERY_PROBE = 'DELIVERY_PROBE'

CAPABILITIES_ROTATE_CREDENTIALS

public mixed CAPABILITIES_ROTATE_CREDENTIALS = 'ROTATE_CREDENTIALS'

CAPABILITIES_VERIFY_CONNECTION

public mixed CAPABILITIES_VERIFY_CONNECTION = 'VERIFY_CONNECTION'

PROVIDER_PRESET_APPLE_ICLOUD

public mixed PROVIDER_PRESET_APPLE_ICLOUD = 'APPLE_ICLOUD'

PROVIDER_PRESET_ELASTIC_EMAIL

public mixed PROVIDER_PRESET_ELASTIC_EMAIL = 'ELASTIC_EMAIL'

PROVIDER_PRESET_GENERIC_SMTP

public mixed PROVIDER_PRESET_GENERIC_SMTP = 'GENERIC_SMTP'

PROVIDER_PRESET_GOOGLE_WORKSPACE

public mixed PROVIDER_PRESET_GOOGLE_WORKSPACE = 'GOOGLE_WORKSPACE'

PROVIDER_PRESET_MICROSOFT_365

public mixed PROVIDER_PRESET_MICROSOFT_365 = 'MICROSOFT_365'

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 = ['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']

$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 = ['id' => 'getId', 'name' => 'getName', 'provider' => 'getProvider', 'provider_preset' => 'getProviderPreset', 'capabilities' => 'getCapabilities', 'from_email' => 'getFromEmail', 'smtp_host' => 'getSmtpHost', 'smtp_port' => 'getSmtpPort', 'smtp_security' => 'getSmtpSecurity', 'username_hint' => 'getUsernameHint', 'api_region' => 'getApiRegion', 'sending_domain' => 'getSendingDomain', 'status' => 'getStatus', 'enabled' => 'getEnabled', 'last_verified_at' => 'getLastVerifiedAt', 'last_error_code' => 'getLastErrorCode', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['id' => 'uuid', 'name' => null, 'provider' => null, 'provider_preset' => null, 'capabilities' => null, 'from_email' => null, 'smtp_host' => null, 'smtp_port' => 'int32', 'smtp_security' => null, 'username_hint' => null, 'api_region' => null, 'sending_domain' => null, 'status' => null, 'enabled' => null, 'last_verified_at' => 'date-time', 'last_error_code' => null, 'created_at' => 'date-time', 'updated_at' => 'date-time']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'SendingConnectionDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['id' => false, 'name' => false, 'provider' => false, 'provider_preset' => false, 'capabilities' => false, 'from_email' => false, 'smtp_host' => true, 'smtp_port' => true, 'smtp_security' => true, 'username_hint' => true, 'api_region' => true, 'sending_domain' => true, 'status' => false, 'enabled' => false, 'last_verified_at' => true, 'last_error_code' => true, 'created_at' => false, 'updated_at' => 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 = ['id' => 'string', 'name' => 'string', 'provider' => 'string', 'provider_preset' => 'string', 'capabilities' => 'string[]', 'from_email' => 'string', 'smtp_host' => 'string', 'smtp_port' => 'int', 'smtp_security' => 'string', 'username_hint' => 'string', 'api_region' => 'string', 'sending_domain' => 'string', 'status' => 'string', 'enabled' => 'bool', 'last_verified_at' => '\\DateTime', 'last_error_code' => 'string', 'created_at' => '\\DateTime', 'updated_at' => '\\DateTime']

$setters

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

protected static array<string|int, string> $setters = ['id' => 'setId', 'name' => 'setName', 'provider' => 'setProvider', 'provider_preset' => 'setProviderPreset', 'capabilities' => 'setCapabilities', 'from_email' => 'setFromEmail', 'smtp_host' => 'setSmtpHost', 'smtp_port' => 'setSmtpPort', 'smtp_security' => 'setSmtpSecurity', 'username_hint' => 'setUsernameHint', 'api_region' => 'setApiRegion', 'sending_domain' => 'setSendingDomain', 'status' => 'setStatus', 'enabled' => 'setEnabled', 'last_verified_at' => 'setLastVerifiedAt', 'last_error_code' => 'setLastErrorCode', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt']

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

getApiRegion()

Gets api_region

public getApiRegion() : string|null
Return values
string|null —

getApiRegionAllowableValues()

Gets allowable values of the enum

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

getCapabilities()

Gets capabilities

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

getCapabilitiesAllowableValues()

Gets allowable values of the enum

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

getCreatedAt()

Gets created_at

public getCreatedAt() : DateTime
Return values
DateTime —

getLastErrorCode()

Gets last_error_code

public getLastErrorCode() : string|null
Return values
string|null —

getLastVerifiedAt()

Gets last_verified_at

public getLastVerifiedAt() : DateTime|null
Return values
DateTime|null —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getProviderAllowableValues()

Gets allowable values of the enum

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

getProviderPreset()

Gets provider_preset

public getProviderPreset() : string
Return values
string —

getProviderPresetAllowableValues()

Gets allowable values of the enum

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

getSendingDomain()

Gets sending_domain

public getSendingDomain() : string|null
Return values
string|null —

getSmtpHost()

Gets smtp_host

public getSmtpHost() : string|null
Return values
string|null —

getSmtpPort()

Gets smtp_port

public getSmtpPort() : int|null
Return values
int|null —

getSmtpSecurity()

Gets smtp_security

public getSmtpSecurity() : string|null
Return values
string|null —

getSmtpSecurityAllowableValues()

Gets allowable values of the enum

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

getStatusAllowableValues()

Gets allowable values of the enum

public getStatusAllowableValues() : 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> —

getUpdatedAt()

Gets updated_at

public getUpdatedAt() : DateTime
Return values
DateTime —

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 —

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

setApiRegion()

Sets api_region

public setApiRegion(string|null $api_region) : self
Parameters
$api_region : string|null

api_region

Return values
self —

setCapabilities()

Sets capabilities

public setCapabilities(array<string|int, string> $capabilities) : self
Parameters
$capabilities : array<string|int, string>

capabilities

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 $enabled) : self
Parameters
$enabled : bool

enabled

Return values
self —

setFromEmail()

Sets from_email

public setFromEmail(string $from_email) : self
Parameters
$from_email : string

from_email

Return values
self —

setId()

Sets id

public setId(string $id) : self
Parameters
$id : string

id

Return values
self —

setLastErrorCode()

Sets last_error_code

public setLastErrorCode(string|null $last_error_code) : self
Parameters
$last_error_code : string|null

last_error_code

Return values
self —

setLastVerifiedAt()

Sets last_verified_at

public setLastVerifiedAt(DateTime|null $last_verified_at) : self
Parameters
$last_verified_at : DateTime|null

last_verified_at

Return values
self —

setName()

Sets name

public setName(string $name) : self
Parameters
$name : string

name

Return values
self —

setProvider()

Sets provider

public setProvider(string $provider) : self
Parameters
$provider : string

provider

Return values
self —

setProviderPreset()

Sets provider_preset

public setProviderPreset(string $provider_preset) : self
Parameters
$provider_preset : string

provider_preset

Return values
self —

setSendingDomain()

Sets sending_domain

public setSendingDomain(string|null $sending_domain) : self
Parameters
$sending_domain : string|null

sending_domain

Return values
self —

setSmtpHost()

Sets smtp_host

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

smtp_host

Return values
self —

setSmtpPort()

Sets smtp_port

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

smtp_port

Return values
self —

setSmtpSecurity()

Sets smtp_security

public setSmtpSecurity(string|null $smtp_security) : self
Parameters
$smtp_security : string|null

smtp_security

Return values
self —

setStatus()

Sets status

public setStatus(string $status) : self
Parameters
$status : string

status

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

setUpdatedAt()

Sets updated_at

public setUpdatedAt(DateTime $updated_at) : self
Parameters
$updated_at : DateTime

updated_at

Return values
self —

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

Search results