CreateConnectorWithOptionsCreateConnectorImapConnectionOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
CreateConnectorWithOptionsCreateConnectorImapConnectionOptions Class Doc Comment
Tags
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
- getEnabled() : bool|null
- Gets enabled
- getImapHost() : string
- Gets imap_host
- getImapPassword() : string|null
- Gets imap_password
- getImapPort() : int|null
- Gets imap_port
- getImapSsl() : bool|null
- Gets imap_ssl
- getImapUsername() : string|null
- Gets imap_username
- getLocalHostName() : string|null
- Gets local_host_name
- getMechanisms() : array<string|int, string>|null
- Gets mechanisms
- 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
- getSearchTerms() : string|null
- Gets search_terms
- getSelectFolder() : string|null
- Gets select_folder
- 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
- setEnabled() : self
- Sets enabled
- setImapHost() : self
- Sets imap_host
- setImapPassword() : self
- Sets imap_password
- setImapPort() : self
- Sets imap_port
- setImapSsl() : self
- Sets imap_ssl
- setImapUsername() : self
- Sets imap_username
- setLocalHostName() : self
- Sets local_host_name
- setMechanisms() : self
- Sets mechanisms
- setProxyEnabled() : self
- Sets proxy_enabled
- setProxyHost() : self
- Sets proxy_host
- setProxyPort() : self
- Sets proxy_port
- setSearchTerms() : self
- Sets search_terms
- setSelectFolder() : self
- Sets select_folder
- 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
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
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
= ['imap_ssl' => 'imapSsl', 'imap_username' => 'imapUsername', 'imap_password' => 'imapPassword', 'select_folder' => 'selectFolder', 'search_terms' => 'searchTerms', 'imap_port' => 'imapPort', 'imap_host' => 'imapHost', 'enabled' => 'enabled', 'start_tls' => 'startTls', 'proxy_enabled' => 'proxyEnabled', 'proxy_port' => 'proxyPort', 'proxy_host' => 'proxyHost', 'local_host_name' => 'localHostName', 'mechanisms' => 'mechanisms', 'ssl_trust' => 'sslTrust', 'ssl_protocols' => 'sslProtocols']
$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
= ['imap_ssl' => 'getImapSsl', 'imap_username' => 'getImapUsername', 'imap_password' => 'getImapPassword', 'select_folder' => 'getSelectFolder', 'search_terms' => 'getSearchTerms', 'imap_port' => 'getImapPort', 'imap_host' => 'getImapHost', 'enabled' => 'getEnabled', 'start_tls' => 'getStartTls', 'proxy_enabled' => 'getProxyEnabled', 'proxy_port' => 'getProxyPort', 'proxy_host' => 'getProxyHost', 'local_host_name' => 'getLocalHostName', 'mechanisms' => 'getMechanisms', 'ssl_trust' => 'getSslTrust', 'ssl_protocols' => 'getSslProtocols']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['imap_ssl' => null, 'imap_username' => null, 'imap_password' => null, 'select_folder' => null, 'search_terms' => null, 'imap_port' => 'int32', 'imap_host' => null, 'enabled' => null, 'start_tls' => null, 'proxy_enabled' => null, 'proxy_port' => 'int32', 'proxy_host' => null, 'local_host_name' => null, 'mechanisms' => null, 'ssl_trust' => null, 'ssl_protocols' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'CreateConnectorWithOptions_createConnectorImapConnectionOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['imap_ssl' => true, 'imap_username' => true, 'imap_password' => true, 'select_folder' => true, 'search_terms' => true, 'imap_port' => true, 'imap_host' => false, 'enabled' => true, 'start_tls' => true, 'proxy_enabled' => true, 'proxy_port' => true, 'proxy_host' => true, 'local_host_name' => true, 'mechanisms' => true, 'ssl_trust' => true, 'ssl_protocols' => 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
= ['imap_ssl' => 'bool', 'imap_username' => 'string', 'imap_password' => 'string', 'select_folder' => 'string', 'search_terms' => 'string', 'imap_port' => 'int', 'imap_host' => 'string', 'enabled' => 'bool', 'start_tls' => 'bool', 'proxy_enabled' => 'bool', 'proxy_port' => 'int', 'proxy_host' => 'string', 'local_host_name' => 'string', 'mechanisms' => 'string[]', 'ssl_trust' => 'string', 'ssl_protocols' => 'string[]']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['imap_ssl' => 'setImapSsl', 'imap_username' => 'setImapUsername', 'imap_password' => 'setImapPassword', 'select_folder' => 'setSelectFolder', 'search_terms' => 'setSearchTerms', 'imap_port' => 'setImapPort', 'imap_host' => 'setImapHost', 'enabled' => 'setEnabled', 'start_tls' => 'setStartTls', 'proxy_enabled' => 'setProxyEnabled', 'proxy_port' => 'setProxyPort', 'proxy_host' => 'setProxyHost', 'local_host_name' => 'setLocalHostName', 'mechanisms' => 'setMechanisms', 'ssl_trust' => 'setSslTrust', 'ssl_protocols' => 'setSslProtocols']
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> —getEnabled()
Gets enabled
public
getEnabled() : bool|null
Return values
bool|null —getImapHost()
Gets imap_host
public
getImapHost() : string
Return values
string —getImapPassword()
Gets imap_password
public
getImapPassword() : string|null
Return values
string|null —getImapPort()
Gets imap_port
public
getImapPort() : int|null
Return values
int|null —getImapSsl()
Gets imap_ssl
public
getImapSsl() : bool|null
Return values
bool|null —getImapUsername()
Gets imap_username
public
getImapUsername() : string|null
Return values
string|null —getLocalHostName()
Gets local_host_name
public
getLocalHostName() : string|null
Return values
string|null —getMechanisms()
Gets mechanisms
public
getMechanisms() : array<string|int, string>|null
Return values
array<string|int, string>|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getProxyEnabled()
Gets proxy_enabled
public
getProxyEnabled() : bool|null
Return values
bool|null —getProxyHost()
Gets proxy_host
public
getProxyHost() : string|null
Return values
string|null —getProxyPort()
Gets proxy_port
public
getProxyPort() : int|null
Return values
int|null —getSearchTerms()
Gets search_terms
public
getSearchTerms() : string|null
Return values
string|null —getSelectFolder()
Gets select_folder
public
getSelectFolder() : string|null
Return values
string|null —getSslProtocols()
Gets ssl_protocols
public
getSslProtocols() : array<string|int, string>|null
Return values
array<string|int, string>|null —getSslTrust()
Gets ssl_trust
public
getSslTrust() : string|null
Return values
string|null —getStartTls()
Gets start_tls
public
getStartTls() : bool|null
Return values
bool|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 —jsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
Return values
mixed —Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.
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> —setEnabled()
Sets enabled
public
setEnabled(bool|null $enabled) : self
Parameters
- $enabled : bool|null
-
IMAP server enabled
Return values
self —setImapHost()
Sets imap_host
public
setImapHost(string $imap_host) : self
Parameters
- $imap_host : string
-
IMAP server host
Return values
self —setImapPassword()
Sets imap_password
public
setImapPassword(string|null $imap_password) : self
Parameters
- $imap_password : string|null
-
imap_password
Return values
self —setImapPort()
Sets imap_port
public
setImapPort(int|null $imap_port) : self
Parameters
- $imap_port : int|null
-
IMAP server port
Return values
self —setImapSsl()
Sets imap_ssl
public
setImapSsl(bool|null $imap_ssl) : self
Parameters
- $imap_ssl : bool|null
-
imap_ssl
Return values
self —setImapUsername()
Sets imap_username
public
setImapUsername(string|null $imap_username) : self
Parameters
- $imap_username : string|null
-
imap_username
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 —setMechanisms()
Sets mechanisms
public
setMechanisms(array<string|int, string>|null $mechanisms) : self
Parameters
- $mechanisms : array<string|int, string>|null
-
List of IMAP mechanisms
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 —setSearchTerms()
Sets search_terms
public
setSearchTerms(string|null $search_terms) : self
Parameters
- $search_terms : string|null
-
search_terms
Return values
self —setSelectFolder()
Sets select_folder
public
setSelectFolder(string|null $select_folder) : self
Parameters
- $select_folder : string|null
-
Optional folder to select during IMAP connection
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
-
List of 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>