EmailIntelligenceOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
EmailIntelligenceOptions 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
- getIgnoreCache() : bool|null
- Gets ignore_cache
- getIncludeEmailValidation() : bool|null
- Gets include_email_validation
- getModelName() : string
- The original name of the model.
- getPage() : int|null
- Gets page
- getSize() : int|null
- Gets size
- getTargets() : array<string|int, string>
- Gets targets
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTests() : EmailIntelligenceOptionsTests|null
- Gets tests
- 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
- setIgnoreCache() : self
- Sets ignore_cache
- setIncludeEmailValidation() : self
- Sets include_email_validation
- setPage() : self
- Sets page
- setSize() : self
- Sets size
- setTargets() : self
- Sets targets
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTests() : self
- Sets tests
- 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
= ['targets' => 'targets', 'page' => 'page', 'size' => 'size', 'ignore_cache' => 'ignoreCache', 'include_email_validation' => 'includeEmailValidation', 'tests' => 'tests']
$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
= ['targets' => 'getTargets', 'page' => 'getPage', 'size' => 'getSize', 'ignore_cache' => 'getIgnoreCache', 'include_email_validation' => 'getIncludeEmailValidation', 'tests' => 'getTests']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['targets' => null, 'page' => 'int32', 'size' => 'int32', 'ignore_cache' => null, 'include_email_validation' => null, 'tests' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'EmailIntelligenceOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['targets' => false, 'page' => true, 'size' => true, 'ignore_cache' => true, 'include_email_validation' => true, 'tests' => 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
= ['targets' => 'string[]', 'page' => 'int', 'size' => 'int', 'ignore_cache' => 'bool', 'include_email_validation' => 'bool', 'tests' => '\\MailSlurp\\Models\\EmailIntelligenceOptionsTests']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['targets' => 'setTargets', 'page' => 'setPage', 'size' => 'setSize', 'ignore_cache' => 'setIgnoreCache', 'include_email_validation' => 'setIncludeEmailValidation', 'tests' => 'setTests']
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> —getIgnoreCache()
Gets ignore_cache
public
getIgnoreCache() : bool|null
Return values
bool|null —getIncludeEmailValidation()
Gets include_email_validation
public
getIncludeEmailValidation() : bool|null
Return values
bool|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPage()
Gets page
public
getPage() : int|null
Return values
int|null —getSize()
Gets size
public
getSize() : int|null
Return values
int|null —getTargets()
Gets targets
public
getTargets() : 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> —getTests()
Gets tests
public
getTests() : EmailIntelligenceOptionsTests|null
Return values
EmailIntelligenceOptionsTests|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> —setIgnoreCache()
Sets ignore_cache
public
setIgnoreCache(bool|null $ignore_cache) : self
Parameters
- $ignore_cache : bool|null
-
Ignore cached intelligence values and force recomputation.
Return values
self —setIncludeEmailValidation()
Sets include_email_validation
public
setIncludeEmailValidation(bool|null $include_email_validation) : self
Parameters
- $include_email_validation : bool|null
-
Also run mailbox safety verification using the existing verification client for email inputs.
Return values
self —setPage()
Sets page
public
setPage(int|null $page) : self
Parameters
- $page : int|null
-
Zero-based page index for processing a subset of the target list.
Return values
self —setSize()
Sets size
public
setSize(int|null $size) : self
Parameters
- $size : int|null
-
Page size for processing a subset of the target list.
Return values
self —setTargets()
Sets targets
public
setTargets(array<string|int, string> $targets) : self
Parameters
- $targets : array<string|int, string>
-
Email addresses or domains to score.
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> —setTests()
Sets tests
public
setTests(EmailIntelligenceOptionsTests|null $tests) : self
Parameters
- $tests : EmailIntelligenceOptionsTests|null
-
tests
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>