ImapServerSearchOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
ImapServerSearchOptions 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
- getBefore() : DateTime|null
- Gets before
- getBody() : array<string|int, string>|null
- Gets body
- getHeader() : array<string, array<string|int, string>>|null
- Gets header
- getModelName() : string
- The original name of the model.
- getSentBefore() : DateTime|null
- Gets sent_before
- getSentSince() : DateTime|null
- Gets sent_since
- getSeqNum() : string|null
- Gets seq_num
- getSince() : DateTime|null
- Gets since
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getText() : array<string|int, string>|null
- Gets text
- getUid() : string|null
- Gets uid
- getWithFlags() : array<string|int, string>|null
- Gets with_flags
- getWithoutFlags() : array<string|int, string>|null
- Gets without_flags
- 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
- setBefore() : self
- Sets before
- setBody() : self
- Sets body
- setHeader() : self
- Sets header
- setSentBefore() : self
- Sets sent_before
- setSentSince() : self
- Sets sent_since
- setSeqNum() : self
- Sets seq_num
- setSince() : self
- Sets since
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setText() : self
- Sets text
- setUid() : self
- Sets uid
- setWithFlags() : self
- Sets with_flags
- setWithoutFlags() : self
- Sets without_flags
- 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
= ['seq_num' => 'seqNum', 'uid' => 'uid', 'since' => 'since', 'before' => 'before', 'sent_since' => 'sentSince', 'sent_before' => 'sentBefore', 'header' => 'header', 'body' => 'body', 'text' => 'text', 'with_flags' => 'withFlags', 'without_flags' => 'withoutFlags']
$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
= ['seq_num' => 'getSeqNum', 'uid' => 'getUid', 'since' => 'getSince', 'before' => 'getBefore', 'sent_since' => 'getSentSince', 'sent_before' => 'getSentBefore', 'header' => 'getHeader', 'body' => 'getBody', 'text' => 'getText', 'with_flags' => 'getWithFlags', 'without_flags' => 'getWithoutFlags']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['seq_num' => null, 'uid' => null, 'since' => 'date-time', 'before' => 'date-time', 'sent_since' => 'date-time', 'sent_before' => 'date-time', 'header' => null, 'body' => null, 'text' => null, 'with_flags' => null, 'without_flags' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'ImapServerSearchOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['seq_num' => true, 'uid' => true, 'since' => true, 'before' => true, 'sent_since' => true, 'sent_before' => true, 'header' => true, 'body' => true, 'text' => true, 'with_flags' => true, 'without_flags' => 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
= ['seq_num' => 'string', 'uid' => 'string', 'since' => '\\DateTime', 'before' => '\\DateTime', 'sent_since' => '\\DateTime', 'sent_before' => '\\DateTime', 'header' => 'array<string,string[]>', 'body' => 'string[]', 'text' => 'string[]', 'with_flags' => 'string[]', 'without_flags' => 'string[]']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['seq_num' => 'setSeqNum', 'uid' => 'setUid', 'since' => 'setSince', 'before' => 'setBefore', 'sent_since' => 'setSentSince', 'sent_before' => 'setSentBefore', 'header' => 'setHeader', 'body' => 'setBody', 'text' => 'setText', 'with_flags' => 'setWithFlags', 'without_flags' => 'setWithoutFlags']
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> —getBefore()
Gets before
public
getBefore() : DateTime|null
Return values
DateTime|null —getBody()
Gets body
public
getBody() : array<string|int, string>|null
Return values
array<string|int, string>|null —getHeader()
Gets header
public
getHeader() : array<string, array<string|int, string>>|null
Return values
array<string, array<string|int, string>>|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getSentBefore()
Gets sent_before
public
getSentBefore() : DateTime|null
Return values
DateTime|null —getSentSince()
Gets sent_since
public
getSentSince() : DateTime|null
Return values
DateTime|null —getSeqNum()
Gets seq_num
public
getSeqNum() : string|null
Return values
string|null —getSince()
Gets since
public
getSince() : DateTime|null
Return values
DateTime|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> —getText()
Gets text
public
getText() : array<string|int, string>|null
Return values
array<string|int, string>|null —getUid()
Gets uid
public
getUid() : string|null
Return values
string|null —getWithFlags()
Gets with_flags
public
getWithFlags() : array<string|int, string>|null
Return values
array<string|int, string>|null —getWithoutFlags()
Gets without_flags
public
getWithoutFlags() : array<string|int, string>|null
Return values
array<string|int, 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 —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> —setBefore()
Sets before
public
setBefore(DateTime|null $before) : self
Parameters
- $before : DateTime|null
-
before
Return values
self —setBody()
Sets body
public
setBody(array<string|int, string>|null $body) : self
Parameters
- $body : array<string|int, string>|null
-
body
Return values
self —setHeader()
Sets header
public
setHeader(array<string, array<string|int, string>>|null $header) : self
Parameters
- $header : array<string, array<string|int, string>>|null
-
header
Return values
self —setSentBefore()
Sets sent_before
public
setSentBefore(DateTime|null $sent_before) : self
Parameters
- $sent_before : DateTime|null
-
sent_before
Return values
self —setSentSince()
Sets sent_since
public
setSentSince(DateTime|null $sent_since) : self
Parameters
- $sent_since : DateTime|null
-
sent_since
Return values
self —setSeqNum()
Sets seq_num
public
setSeqNum(string|null $seq_num) : self
Parameters
- $seq_num : string|null
-
seq_num
Return values
self —setSince()
Sets since
public
setSince(DateTime|null $since) : self
Parameters
- $since : DateTime|null
-
since
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> —setText()
Sets text
public
setText(array<string|int, string>|null $text) : self
Parameters
- $text : array<string|int, string>|null
-
text
Return values
self —setUid()
Sets uid
public
setUid(string|null $uid) : self
Parameters
- $uid : string|null
-
uid
Return values
self —setWithFlags()
Sets with_flags
public
setWithFlags(array<string|int, string>|null $with_flags) : self
Parameters
- $with_flags : array<string|int, string>|null
-
with_flags
Return values
self —setWithoutFlags()
Sets without_flags
public
setWithoutFlags(array<string|int, string>|null $without_flags) : self
Parameters
- $without_flags : array<string|int, string>|null
-
without_flags
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>