Documentation

ImapMailboxStatus
in package
implements ModelInterface, ArrayAccess, JsonSerializable

ImapMailboxStatus 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
$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
getAppendLimit()  : int|null
Gets append_limit
getFlags()  : array<string|int, string>
Gets flags
getItems()  : object
Gets items
getMessages()  : int
Gets messages
getModelName()  : string
The original name of the model.
getName()  : string
Gets name
getPermanentFlags()  : array<string|int, string>
Gets permanent_flags
getReadOnly()  : bool
Gets read_only
getRecent()  : int
Gets recent
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUidNext()  : int
Gets uid_next
getUidValidity()  : int
Gets uid_validity
getUnseen()  : int
Gets unseen
getUnseenSeqNum()  : int
Gets unseen_seq_num
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
setAppendLimit()  : self
Sets append_limit
setFlags()  : self
Sets flags
setItems()  : self
Sets items
setMessages()  : self
Sets messages
setName()  : self
Sets name
setPermanentFlags()  : self
Sets permanent_flags
setReadOnly()  : self
Sets read_only
setRecent()  : self
Sets recent
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUidNext()  : self
Sets uid_next
setUidValidity()  : self
Sets uid_validity
setUnseen()  : self
Sets unseen
setUnseenSeqNum()  : self
Sets unseen_seq_num
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', 'read_only' => 'readOnly', 'items' => 'items', 'flags' => 'flags', 'permanent_flags' => 'permanentFlags', 'unseen_seq_num' => 'unseenSeqNum', 'messages' => 'messages', 'recent' => 'recent', 'unseen' => 'unseen', 'uid_next' => 'uidNext', 'uid_validity' => 'uidValidity', 'append_limit' => 'appendLimit']

$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 = ['name' => 'getName', 'read_only' => 'getReadOnly', 'items' => 'getItems', 'flags' => 'getFlags', 'permanent_flags' => 'getPermanentFlags', 'unseen_seq_num' => 'getUnseenSeqNum', 'messages' => 'getMessages', 'recent' => 'getRecent', 'unseen' => 'getUnseen', 'uid_next' => 'getUidNext', 'uid_validity' => 'getUidValidity', 'append_limit' => 'getAppendLimit']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['name' => null, 'read_only' => null, 'items' => null, 'flags' => null, 'permanent_flags' => null, 'unseen_seq_num' => 'int64', 'messages' => 'int32', 'recent' => 'int32', 'unseen' => 'int32', 'uid_next' => 'int64', 'uid_validity' => 'int32', 'append_limit' => 'int32']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'ImapMailboxStatus'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['name' => false, 'read_only' => false, 'items' => true, 'flags' => true, 'permanent_flags' => true, 'unseen_seq_num' => false, 'messages' => false, 'recent' => false, 'unseen' => false, 'uid_next' => false, 'uid_validity' => false, 'append_limit' => 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', 'read_only' => 'bool', 'items' => 'object', 'flags' => 'string[]', 'permanent_flags' => 'string[]', 'unseen_seq_num' => 'int', 'messages' => 'int', 'recent' => 'int', 'unseen' => 'int', 'uid_next' => 'int', 'uid_validity' => 'int', 'append_limit' => 'int']

$setters

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

protected static array<string|int, string> $setters = ['name' => 'setName', 'read_only' => 'setReadOnly', 'items' => 'setItems', 'flags' => 'setFlags', 'permanent_flags' => 'setPermanentFlags', 'unseen_seq_num' => 'setUnseenSeqNum', 'messages' => 'setMessages', 'recent' => 'setRecent', 'unseen' => 'setUnseen', 'uid_next' => 'setUidNext', 'uid_validity' => 'setUidValidity', 'append_limit' => 'setAppendLimit']

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>

getAppendLimit()

Gets append_limit

public getAppendLimit() : int|null
Return values
int|null

getFlags()

Gets flags

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

getMessages()

Gets messages

public getMessages() : int
Return values
int

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getPermanentFlags()

Gets permanent_flags

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

getReadOnly()

Gets read_only

public getReadOnly() : bool
Return values
bool

getters()

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

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

getUidValidity()

Gets uid_validity

public getUidValidity() : int
Return values
int

getUnseenSeqNum()

Gets unseen_seq_num

public getUnseenSeqNum() : int
Return values
int

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>

setAppendLimit()

Sets append_limit

public setAppendLimit(int|null $append_limit) : self
Parameters
$append_limit : int|null

Per-mailbox limit of message size. Set only if server supports the APPENDLIMIT extension

Return values
self

setFlags()

Sets flags

public setFlags(array<string|int, string> $flags) : self
Parameters
$flags : array<string|int, string>

The mailbox flags.

Return values
self

setItems()

Sets items

public setItems(object $items) : self
Parameters
$items : object

Results map

Return values
self

setMessages()

Sets messages

public setMessages(int $messages) : self
Parameters
$messages : int

The number of messages in this mailbox.

Return values
self

setName()

Sets name

public setName(string $name) : self
Parameters
$name : string

The mailbox name.

Return values
self

setPermanentFlags()

Sets permanent_flags

public setPermanentFlags(array<string|int, string> $permanent_flags) : self
Parameters
$permanent_flags : array<string|int, string>

The mailbox permanent flags.

Return values
self

setReadOnly()

Sets read_only

public setReadOnly(bool $read_only) : self
Parameters
$read_only : bool

True if the mailbox is open in read-only mode.

Return values
self

setRecent()

Sets recent

public setRecent(int $recent) : self
Parameters
$recent : int

The number of messages not seen since the last time the mailbox was opened.

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>

setUidNext()

Sets uid_next

public setUidNext(int $uid_next) : self
Parameters
$uid_next : int

The next UID.

Return values
self

setUidValidity()

Sets uid_validity

public setUidValidity(int $uid_validity) : self
Parameters
$uid_validity : int

Together with a UID, it is a unique identifier for a message. Must be greater than or equal to 1.

Return values
self

setUnseen()

Sets unseen

public setUnseen(int $unseen) : self
Parameters
$unseen : int

The number of unread messages.

Return values
self

setUnseenSeqNum()

Sets unseen_seq_num

public setUnseenSeqNum(int $unseen_seq_num) : self
Parameters
$unseen_seq_num : int

The sequence number of the first unseen message in the mailbox.

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