Documentation

ImapAccessDetails
in package
implements ModelInterface, ArrayAccess, JsonSerializable

ImapAccessDetails Class Doc Comment

Tags
category

Class

description

Access details for inbox using IMAP

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
getImapMailbox()  : string
Gets imap_mailbox
getImapPassword()  : string
Gets imap_password
getImapServerHost()  : string
Gets imap_server_host
getImapServerPort()  : int
Gets imap_server_port
getImapUsername()  : string
Gets imap_username
getModelName()  : string
The original name of the model.
getSecureImapPassword()  : string
Gets secure_imap_password
getSecureImapServerHost()  : string
Gets secure_imap_server_host
getSecureImapServerPort()  : int
Gets secure_imap_server_port
getSecureImapUsername()  : string
Gets secure_imap_username
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
setImapMailbox()  : self
Sets imap_mailbox
setImapPassword()  : self
Sets imap_password
setImapServerHost()  : self
Sets imap_server_host
setImapServerPort()  : self
Sets imap_server_port
setImapUsername()  : self
Sets imap_username
setSecureImapPassword()  : self
Sets secure_imap_password
setSecureImapServerHost()  : self
Sets secure_imap_server_host
setSecureImapServerPort()  : self
Sets secure_imap_server_port
setSecureImapUsername()  : self
Sets secure_imap_username
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 = ['secure_imap_server_host' => 'secureImapServerHost', 'secure_imap_server_port' => 'secureImapServerPort', 'secure_imap_username' => 'secureImapUsername', 'secure_imap_password' => 'secureImapPassword', 'imap_server_host' => 'imapServerHost', 'imap_server_port' => 'imapServerPort', 'imap_username' => 'imapUsername', 'imap_password' => 'imapPassword', 'imap_mailbox' => 'imapMailbox']

$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 = ['secure_imap_server_host' => 'getSecureImapServerHost', 'secure_imap_server_port' => 'getSecureImapServerPort', 'secure_imap_username' => 'getSecureImapUsername', 'secure_imap_password' => 'getSecureImapPassword', 'imap_server_host' => 'getImapServerHost', 'imap_server_port' => 'getImapServerPort', 'imap_username' => 'getImapUsername', 'imap_password' => 'getImapPassword', 'imap_mailbox' => 'getImapMailbox']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['secure_imap_server_host' => null, 'secure_imap_server_port' => 'int32', 'secure_imap_username' => null, 'secure_imap_password' => null, 'imap_server_host' => null, 'imap_server_port' => 'int32', 'imap_username' => null, 'imap_password' => null, 'imap_mailbox' => 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 = 'ImapAccessDetails'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['secure_imap_server_host' => false, 'secure_imap_server_port' => false, 'secure_imap_username' => false, 'secure_imap_password' => false, 'imap_server_host' => false, 'imap_server_port' => false, 'imap_username' => false, 'imap_password' => false, 'imap_mailbox' => 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 = ['secure_imap_server_host' => 'string', 'secure_imap_server_port' => 'int', 'secure_imap_username' => 'string', 'secure_imap_password' => 'string', 'imap_server_host' => 'string', 'imap_server_port' => 'int', 'imap_username' => 'string', 'imap_password' => 'string', 'imap_mailbox' => 'string']

$setters

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

protected static array<string|int, string> $setters = ['secure_imap_server_host' => 'setSecureImapServerHost', 'secure_imap_server_port' => 'setSecureImapServerPort', 'secure_imap_username' => 'setSecureImapUsername', 'secure_imap_password' => 'setSecureImapPassword', 'imap_server_host' => 'setImapServerHost', 'imap_server_port' => 'setImapServerPort', 'imap_username' => 'setImapUsername', 'imap_password' => 'setImapPassword', 'imap_mailbox' => 'setImapMailbox']

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>

getImapMailbox()

Gets imap_mailbox

public getImapMailbox() : string
Return values
string

getImapPassword()

Gets imap_password

public getImapPassword() : string
Return values
string

getImapServerHost()

Gets imap_server_host

public getImapServerHost() : string
Return values
string

getImapServerPort()

Gets imap_server_port

public getImapServerPort() : int
Return values
int

getImapUsername()

Gets imap_username

public getImapUsername() : string
Return values
string

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getSecureImapPassword()

Gets secure_imap_password

public getSecureImapPassword() : string
Return values
string

getSecureImapServerHost()

Gets secure_imap_server_host

public getSecureImapServerHost() : string
Return values
string

getSecureImapServerPort()

Gets secure_imap_server_port

public getSecureImapServerPort() : int
Return values
int

getSecureImapUsername()

Gets secure_imap_username

public getSecureImapUsername() : string
Return values
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

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>

setImapMailbox()

Sets imap_mailbox

public setImapMailbox(string $imap_mailbox) : self
Parameters
$imap_mailbox : string

IMAP mailbox to SELECT

Return values
self

setImapPassword()

Sets imap_password

public setImapPassword(string $imap_password) : self
Parameters
$imap_password : string

IMAP password for login

Return values
self

setImapServerHost()

Sets imap_server_host

public setImapServerHost(string $imap_server_host) : self
Parameters
$imap_server_host : string

IMAP server host domain

Return values
self

setImapServerPort()

Sets imap_server_port

public setImapServerPort(int $imap_server_port) : self
Parameters
$imap_server_port : int

IMAP server host port

Return values
self

setImapUsername()

Sets imap_username

public setImapUsername(string $imap_username) : self
Parameters
$imap_username : string

IMAP username for login

Return values
self

setSecureImapPassword()

Sets secure_imap_password

public setSecureImapPassword(string $secure_imap_password) : self
Parameters
$secure_imap_password : string

Secure TLS IMAP password for login

Return values
self

setSecureImapServerHost()

Sets secure_imap_server_host

public setSecureImapServerHost(string $secure_imap_server_host) : self
Parameters
$secure_imap_server_host : string

Secure TLS IMAP server host domain

Return values
self

setSecureImapServerPort()

Sets secure_imap_server_port

public setSecureImapServerPort(int $secure_imap_server_port) : self
Parameters
$secure_imap_server_port : int

Secure TLS IMAP server host port

Return values
self

setSecureImapUsername()

Sets secure_imap_username

public setSecureImapUsername(string $secure_imap_username) : self
Parameters
$secure_imap_username : string

Secure TLS IMAP username for login

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