Documentation

ReplyToAliasEmailOptions
in package
implements ModelInterface, ArrayAccess, JsonSerializable

ReplyToAliasEmailOptions Class Doc Comment

Tags
category

Class

description

Options for replying to an alias email using the alias inbox

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
SEND_STRATEGY_SINGLE_MESSAGE  = 'SINGLE_MESSAGE'
$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
getAttachments()  : array<string|int, string>|null
Gets attachments
getBody()  : string
Gets body
getCharset()  : string|null
Gets charset
getCustomHeaders()  : array<string, string>|null
Gets custom_headers
getHtml()  : bool|null
Gets html
getIsHtml()  : bool
Gets is_html
getModelName()  : string
The original name of the model.
getSendStrategy()  : string|null
Gets send_strategy
getSendStrategyAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getTemplate()  : string|null
Gets template
getTemplateVariables()  : array<string, object>|null
Gets template_variables
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUseInboxName()  : bool|null
Gets use_inbox_name
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
setAttachments()  : self
Sets attachments
setBody()  : self
Sets body
setCharset()  : self
Sets charset
setCustomHeaders()  : self
Sets custom_headers
setHtml()  : self
Sets html
setIsHtml()  : self
Sets is_html
setSendStrategy()  : self
Sets send_strategy
setTemplate()  : self
Sets template
setTemplateVariables()  : self
Sets template_variables
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUseInboxName()  : self
Sets use_inbox_name
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 = ['body' => 'body', 'is_html' => 'isHTML', 'charset' => 'charset', 'attachments' => 'attachments', 'template_variables' => 'templateVariables', 'template' => 'template', 'send_strategy' => 'sendStrategy', 'custom_headers' => 'customHeaders', 'use_inbox_name' => 'useInboxName', 'html' => 'html']

$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 = ['body' => 'getBody', 'is_html' => 'getIsHtml', 'charset' => 'getCharset', 'attachments' => 'getAttachments', 'template_variables' => 'getTemplateVariables', 'template' => 'getTemplate', 'send_strategy' => 'getSendStrategy', 'custom_headers' => 'getCustomHeaders', 'use_inbox_name' => 'getUseInboxName', 'html' => 'getHtml']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['body' => null, 'is_html' => null, 'charset' => null, 'attachments' => null, 'template_variables' => null, 'template' => 'uuid', 'send_strategy' => null, 'custom_headers' => null, 'use_inbox_name' => null, 'html' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'ReplyToAliasEmailOptions'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['body' => false, 'is_html' => false, 'charset' => true, 'attachments' => true, 'template_variables' => true, 'template' => true, 'send_strategy' => true, 'custom_headers' => true, 'use_inbox_name' => true, 'html' => 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 = ['body' => 'string', 'is_html' => 'bool', 'charset' => 'string', 'attachments' => 'string[]', 'template_variables' => 'array<string,object>', 'template' => 'string', 'send_strategy' => 'string', 'custom_headers' => 'array<string,string>', 'use_inbox_name' => 'bool', 'html' => 'bool']

$setters

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

protected static array<string|int, string> $setters = ['body' => 'setBody', 'is_html' => 'setIsHtml', 'charset' => 'setCharset', 'attachments' => 'setAttachments', 'template_variables' => 'setTemplateVariables', 'template' => 'setTemplate', 'send_strategy' => 'setSendStrategy', 'custom_headers' => 'setCustomHeaders', 'use_inbox_name' => 'setUseInboxName', 'html' => 'setHtml']

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

getAttachments()

Gets attachments

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

getCustomHeaders()

Gets custom_headers

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

getSendStrategy()

Gets send_strategy

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

getSendStrategyAllowableValues()

Gets allowable values of the enum

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

getTemplateVariables()

Gets template_variables

public getTemplateVariables() : array<string, object>|null
Return values
array<string, object>|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> —

setAttachments()

Sets attachments

public setAttachments(array<string|int, string>|null $attachments) : self
Parameters
$attachments : array<string|int, string>|null

List of uploaded attachments to send with the reply. Optional.

Return values
self —

setBody()

Sets body

public setBody(string $body) : self
Parameters
$body : string

Body of the reply email you want to send

Return values
self —

setCharset()

Sets charset

public setCharset(string|null $charset) : self
Parameters
$charset : string|null

The charset that your message should be sent with. Optional. Default is UTF-8

Return values
self —

setCustomHeaders()

Sets custom_headers

public setCustomHeaders(array<string, string>|null $custom_headers) : self
Parameters
$custom_headers : array<string, string>|null

Optional custom headers

Return values
self —

setHtml()

Sets html

public setHtml(bool|null $html) : self
Parameters
$html : bool|null

html

Return values
self —

setIsHtml()

Sets is_html

public setIsHtml(bool $is_html) : self
Parameters
$is_html : bool

Is the reply HTML

Return values
self —

setSendStrategy()

Sets send_strategy

public setSendStrategy(string|null $send_strategy) : self
Parameters
$send_strategy : string|null

How an email should be sent based on its recipients

Return values
self —

setTemplate()

Sets template

public setTemplate(string|null $template) : self
Parameters
$template : string|null

Template ID to use instead of body. Will use template variable map to fill defined variable slots.

Return values
self —

setTemplateVariables()

Sets template_variables

public setTemplateVariables(array<string, object>|null $template_variables) : self
Parameters
$template_variables : array<string, object>|null

Template variables if using a template

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

setUseInboxName()

Sets use_inbox_name

public setUseInboxName(bool|null $use_inbox_name) : self
Parameters
$use_inbox_name : bool|null

Optionally use inbox name as display name for sender email address

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