SearchEmailsOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
SearchEmailsOptions Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- SORT_DIRECTION_ASC = 'ASC'
- SORT_DIRECTION_DESC = 'DESC'
- $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
- getInboxIds() : array<string|int, string>|null
- Gets inbox_ids
- getModelName() : string
- The original name of the model.
- getPageIndex() : int|null
- Gets page_index
- getPageSize() : int|null
- Gets page_size
- getSearchFilter() : string|null
- Gets search_filter
- getSince() : DateTime|null
- Gets since
- getSortDirection() : string|null
- Gets sort_direction
- getSortDirectionAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUnreadOnly() : bool|null
- Gets unread_only
- 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
- setInboxIds() : self
- Sets inbox_ids
- setPageIndex() : self
- Sets page_index
- setPageSize() : self
- Sets page_size
- setSearchFilter() : self
- Sets search_filter
- setSince() : self
- Sets since
- setSortDirection() : self
- Sets sort_direction
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUnreadOnly() : self
- Sets unread_only
- 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
SORT_DIRECTION_ASC
public
mixed
SORT_DIRECTION_ASC
= 'ASC'
SORT_DIRECTION_DESC
public
mixed
SORT_DIRECTION_DESC
= 'DESC'
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
= ['inbox_ids' => 'inboxIds', 'page_index' => 'pageIndex', 'page_size' => 'pageSize', 'sort_direction' => 'sortDirection', 'unread_only' => 'unreadOnly', 'search_filter' => 'searchFilter', 'since' => 'since', 'before' => 'before']
$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
= ['inbox_ids' => 'getInboxIds', 'page_index' => 'getPageIndex', 'page_size' => 'getPageSize', 'sort_direction' => 'getSortDirection', 'unread_only' => 'getUnreadOnly', 'search_filter' => 'getSearchFilter', 'since' => 'getSince', 'before' => 'getBefore']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['inbox_ids' => 'uuid', 'page_index' => 'int32', 'page_size' => 'int32', 'sort_direction' => null, 'unread_only' => null, 'search_filter' => null, 'since' => 'date-time', 'before' => 'date-time']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'SearchEmailsOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['inbox_ids' => false, 'page_index' => false, 'page_size' => false, 'sort_direction' => false, 'unread_only' => false, 'search_filter' => false, 'since' => false, 'before' => 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
= ['inbox_ids' => 'string[]', 'page_index' => 'int', 'page_size' => 'int', 'sort_direction' => 'string', 'unread_only' => 'bool', 'search_filter' => 'string', 'since' => '\\DateTime', 'before' => '\\DateTime']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['inbox_ids' => 'setInboxIds', 'page_index' => 'setPageIndex', 'page_size' => 'setPageSize', 'sort_direction' => 'setSortDirection', 'unread_only' => 'setUnreadOnly', 'search_filter' => 'setSearchFilter', 'since' => 'setSince', 'before' => 'setBefore']
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 —getInboxIds()
Gets inbox_ids
public
getInboxIds() : 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 —getPageIndex()
Gets page_index
public
getPageIndex() : int|null
Return values
int|null —getPageSize()
Gets page_size
public
getPageSize() : int|null
Return values
int|null —getSearchFilter()
Gets search_filter
public
getSearchFilter() : string|null
Return values
string|null —getSince()
Gets since
public
getSince() : DateTime|null
Return values
DateTime|null —getSortDirection()
Gets sort_direction
public
getSortDirection() : string|null
Return values
string|null —getSortDirectionAllowableValues()
Gets allowable values of the enum
public
getSortDirectionAllowableValues() : array<string|int, string>
Return values
array<string|int, 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> —getUnreadOnly()
Gets unread_only
public
getUnreadOnly() : bool|null
Return values
bool|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
-
Optional filter emails received before given date time
Return values
self —setInboxIds()
Sets inbox_ids
public
setInboxIds(array<string|int, string>|null $inbox_ids) : self
Parameters
- $inbox_ids : array<string|int, string>|null
-
Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
Return values
self —setPageIndex()
Sets page_index
public
setPageIndex(int|null $page_index) : self
Parameters
- $page_index : int|null
-
Optional page index in email list pagination
Return values
self —setPageSize()
Sets page_size
public
setPageSize(int|null $page_size) : self
Parameters
- $page_size : int|null
-
Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
Return values
self —setSearchFilter()
Sets search_filter
public
setSearchFilter(string|null $search_filter) : self
Parameters
- $search_filter : string|null
-
Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body
Return values
self —setSince()
Sets since
public
setSince(DateTime|null $since) : self
Parameters
- $since : DateTime|null
-
Optional filter emails received after given date time
Return values
self —setSortDirection()
Sets sort_direction
public
setSortDirection(string|null $sort_direction) : self
Parameters
- $sort_direction : string|null
-
Optional createdAt sort direction ASC or DESC
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> —setUnreadOnly()
Sets unread_only
public
setUnreadOnly(bool|null $unread_only) : self
Parameters
- $unread_only : bool|null
-
Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
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>