Documentation

CreateSendingConnectionOptions
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CreateSendingConnectionOptions 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
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'
$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
getApiKey()  : CreateSendingConnectionOptionsApiKey|null
Gets api_key
getFromEmail()  : string
Gets from_email
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
getSmtp()  : CreateSendingConnectionOptionsSmtp|null
Gets smtp
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
setApiKey()  : self
Sets api_key
setFromEmail()  : self
Sets from_email
setName()  : self
Sets name
setProvider()  : self
Sets provider
setProviderPreset()  : self
Sets provider_preset
setSmtp()  : self
Sets smtp
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 = ['name' => 'name', 'provider_preset' => 'providerPreset', 'provider' => 'provider', 'from_email' => 'fromEmail', 'smtp' => 'smtp', 'api_key' => 'apiKey']

$getters

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

protected static array<string|int, string> $getters = ['name' => 'getName', 'provider_preset' => 'getProviderPreset', 'provider' => 'getProvider', 'from_email' => 'getFromEmail', 'smtp' => 'getSmtp', 'api_key' => 'getApiKey']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['name' => null, 'provider_preset' => null, 'provider' => null, 'from_email' => 'email', 'smtp' => null, 'api_key' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['name' => false, 'provider_preset' => false, 'provider' => false, 'from_email' => false, 'smtp' => true, 'api_key' => 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 = ['name' => 'string', 'provider_preset' => 'string', 'provider' => 'string', 'from_email' => 'string', 'smtp' => '\\MailSlurp\\Models\\CreateSendingConnectionOptionsSmtp', 'api_key' => '\\MailSlurp\\Models\\CreateSendingConnectionOptionsApiKey']

$setters

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

protected static array<string|int, string> $setters = ['name' => 'setName', 'provider_preset' => 'setProviderPreset', 'provider' => 'setProvider', 'from_email' => 'setFromEmail', 'smtp' => 'setSmtp', 'api_key' => 'setApiKey']

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

getProviderAllowableValues()

Gets allowable values of the enum

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

getProviderPresetAllowableValues()

Gets allowable values of the enum

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

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 —

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

setFromEmail()

Sets from_email

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

from_email

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 —

setters()

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

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

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