CheckEmailAuthStackResults
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
CheckEmailAuthStackResults Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- STATUS_CRITICAL = 'CRITICAL'
- STATUS_DEGRADED = 'DEGRADED'
- STATUS_FAILED = 'FAILED'
- STATUS_HEALTHY = 'HEALTHY'
- $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
- getAdvisoryChecks() : array<string|int, string>
- Gets advisory_checks
- getBimi() : LookupBimiDomainResults
- Gets bimi
- getDkim() : LookupDkimDomainResults
- Gets dkim
- getDmarc() : LookupDmarcDomainResults
- Gets dmarc
- getDomain() : string
- Gets domain
- getErrors() : array<string|int, string>
- Gets errors
- getFailingChecks() : int
- Gets failing_checks
- getHealthScore() : int
- Gets health_score
- getInsights() : array<string|int, string>
- Gets insights
- getModelName() : string
- The original name of the model.
- getMtaSts() : LookupMtaStsDomainResults
- Gets mta_sts
- getMx() : LookupMxRecordsResults
- Gets mx
- getPassingChecks() : int
- Gets passing_checks
- getScoreScope() : string
- Gets score_scope
- getScoreVersion() : string
- Gets score_version
- getSpf() : LookupSpfDomainResults
- Gets spf
- getStatus() : string
- Gets status
- getStatusAllowableValues() : 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)
- getTlsReporting() : LookupTlsReportingDomainResults
- Gets tls_reporting
- getTotalChecks() : int
- Gets total_checks
- getWarnings() : array<string|int, string>
- Gets warnings
- 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
- setAdvisoryChecks() : self
- Sets advisory_checks
- setBimi() : self
- Sets bimi
- setDkim() : self
- Sets dkim
- setDmarc() : self
- Sets dmarc
- setDomain() : self
- Sets domain
- setErrors() : self
- Sets errors
- setFailingChecks() : self
- Sets failing_checks
- setHealthScore() : self
- Sets health_score
- setInsights() : self
- Sets insights
- setMtaSts() : self
- Sets mta_sts
- setMx() : self
- Sets mx
- setPassingChecks() : self
- Sets passing_checks
- setScoreScope() : self
- Sets score_scope
- setScoreVersion() : self
- Sets score_version
- setSpf() : self
- Sets spf
- setStatus() : self
- Sets status
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTlsReporting() : self
- Sets tls_reporting
- setTotalChecks() : self
- Sets total_checks
- setWarnings() : self
- Sets warnings
- 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
STATUS_CRITICAL
public
mixed
STATUS_CRITICAL
= 'CRITICAL'
STATUS_DEGRADED
public
mixed
STATUS_DEGRADED
= 'DEGRADED'
STATUS_FAILED
public
mixed
STATUS_FAILED
= 'FAILED'
STATUS_HEALTHY
public
mixed
STATUS_HEALTHY
= 'HEALTHY'
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
= ['domain' => 'domain', 'status' => 'status', 'health_score' => 'healthScore', 'total_checks' => 'totalChecks', 'passing_checks' => 'passingChecks', 'failing_checks' => 'failingChecks', 'spf' => 'spf', 'dmarc' => 'dmarc', 'dkim' => 'dkim', 'bimi' => 'bimi', 'mx' => 'mx', 'mta_sts' => 'mtaSts', 'tls_reporting' => 'tlsReporting', 'insights' => 'insights', 'warnings' => 'warnings', 'errors' => 'errors', 'score_version' => 'scoreVersion', 'score_scope' => 'scoreScope', 'advisory_checks' => 'advisoryChecks']
$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
= ['domain' => 'getDomain', 'status' => 'getStatus', 'health_score' => 'getHealthScore', 'total_checks' => 'getTotalChecks', 'passing_checks' => 'getPassingChecks', 'failing_checks' => 'getFailingChecks', 'spf' => 'getSpf', 'dmarc' => 'getDmarc', 'dkim' => 'getDkim', 'bimi' => 'getBimi', 'mx' => 'getMx', 'mta_sts' => 'getMtaSts', 'tls_reporting' => 'getTlsReporting', 'insights' => 'getInsights', 'warnings' => 'getWarnings', 'errors' => 'getErrors', 'score_version' => 'getScoreVersion', 'score_scope' => 'getScoreScope', 'advisory_checks' => 'getAdvisoryChecks']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['domain' => null, 'status' => null, 'health_score' => 'int32', 'total_checks' => 'int32', 'passing_checks' => 'int32', 'failing_checks' => 'int32', 'spf' => null, 'dmarc' => null, 'dkim' => null, 'bimi' => null, 'mx' => null, 'mta_sts' => null, 'tls_reporting' => null, 'insights' => null, 'warnings' => null, 'errors' => null, 'score_version' => null, 'score_scope' => null, 'advisory_checks' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'CheckEmailAuthStackResults'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['domain' => false, 'status' => false, 'health_score' => false, 'total_checks' => false, 'passing_checks' => false, 'failing_checks' => false, 'spf' => false, 'dmarc' => false, 'dkim' => false, 'bimi' => false, 'mx' => false, 'mta_sts' => false, 'tls_reporting' => false, 'insights' => false, 'warnings' => false, 'errors' => false, 'score_version' => false, 'score_scope' => false, 'advisory_checks' => 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
= ['domain' => 'string', 'status' => 'string', 'health_score' => 'int', 'total_checks' => 'int', 'passing_checks' => 'int', 'failing_checks' => 'int', 'spf' => '\\MailSlurp\\Models\\LookupSpfDomainResults', 'dmarc' => '\\MailSlurp\\Models\\LookupDmarcDomainResults', 'dkim' => '\\MailSlurp\\Models\\LookupDkimDomainResults', 'bimi' => '\\MailSlurp\\Models\\LookupBimiDomainResults', 'mx' => '\\MailSlurp\\Models\\LookupMxRecordsResults', 'mta_sts' => '\\MailSlurp\\Models\\LookupMtaStsDomainResults', 'tls_reporting' => '\\MailSlurp\\Models\\LookupTlsReportingDomainResults', 'insights' => 'string[]', 'warnings' => 'string[]', 'errors' => 'string[]', 'score_version' => 'string', 'score_scope' => 'string', 'advisory_checks' => 'string[]']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['domain' => 'setDomain', 'status' => 'setStatus', 'health_score' => 'setHealthScore', 'total_checks' => 'setTotalChecks', 'passing_checks' => 'setPassingChecks', 'failing_checks' => 'setFailingChecks', 'spf' => 'setSpf', 'dmarc' => 'setDmarc', 'dkim' => 'setDkim', 'bimi' => 'setBimi', 'mx' => 'setMx', 'mta_sts' => 'setMtaSts', 'tls_reporting' => 'setTlsReporting', 'insights' => 'setInsights', 'warnings' => 'setWarnings', 'errors' => 'setErrors', 'score_version' => 'setScoreVersion', 'score_scope' => 'setScoreScope', 'advisory_checks' => 'setAdvisoryChecks']
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> —getAdvisoryChecks()
Gets advisory_checks
public
getAdvisoryChecks() : array<string|int, string>
Return values
array<string|int, string> —getBimi()
Gets bimi
public
getBimi() : LookupBimiDomainResults
Return values
LookupBimiDomainResults —getDkim()
Gets dkim
public
getDkim() : LookupDkimDomainResults
Return values
LookupDkimDomainResults —getDmarc()
Gets dmarc
public
getDmarc() : LookupDmarcDomainResults
Return values
LookupDmarcDomainResults —getDomain()
Gets domain
public
getDomain() : string
Return values
string —getErrors()
Gets errors
public
getErrors() : array<string|int, string>
Return values
array<string|int, string> —getFailingChecks()
Gets failing_checks
public
getFailingChecks() : int
Return values
int —getHealthScore()
Gets health_score
public
getHealthScore() : int
Return values
int —getInsights()
Gets insights
public
getInsights() : array<string|int, string>
Return values
array<string|int, string> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getMtaSts()
Gets mta_sts
public
getMtaSts() : LookupMtaStsDomainResults
Return values
LookupMtaStsDomainResults —getMx()
Gets mx
public
getMx() : LookupMxRecordsResults
Return values
LookupMxRecordsResults —getPassingChecks()
Gets passing_checks
public
getPassingChecks() : int
Return values
int —getScoreScope()
Gets score_scope
public
getScoreScope() : string
Return values
string —getScoreVersion()
Gets score_version
public
getScoreVersion() : string
Return values
string —getSpf()
Gets spf
public
getSpf() : LookupSpfDomainResults
Return values
LookupSpfDomainResults —getStatus()
Gets status
public
getStatus() : string
Return values
string —getStatusAllowableValues()
Gets allowable values of the enum
public
getStatusAllowableValues() : 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> —getTlsReporting()
Gets tls_reporting
public
getTlsReporting() : LookupTlsReportingDomainResults
Return values
LookupTlsReportingDomainResults —getTotalChecks()
Gets total_checks
public
getTotalChecks() : int
Return values
int —getWarnings()
Gets warnings
public
getWarnings() : array<string|int, string>
Return values
array<string|int, string> —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> —setAdvisoryChecks()
Sets advisory_checks
public
setAdvisoryChecks(array<string|int, string> $advisory_checks) : self
Parameters
- $advisory_checks : array<string|int, string>
-
advisory_checks
Return values
self —setBimi()
Sets bimi
public
setBimi(LookupBimiDomainResults $bimi) : self
Parameters
- $bimi : LookupBimiDomainResults
-
bimi
Return values
self —setDkim()
Sets dkim
public
setDkim(LookupDkimDomainResults $dkim) : self
Parameters
- $dkim : LookupDkimDomainResults
-
dkim
Return values
self —setDmarc()
Sets dmarc
public
setDmarc(LookupDmarcDomainResults $dmarc) : self
Parameters
- $dmarc : LookupDmarcDomainResults
-
dmarc
Return values
self —setDomain()
Sets domain
public
setDomain(string $domain) : self
Parameters
- $domain : string
-
domain
Return values
self —setErrors()
Sets errors
public
setErrors(array<string|int, string> $errors) : self
Parameters
- $errors : array<string|int, string>
-
errors
Return values
self —setFailingChecks()
Sets failing_checks
public
setFailingChecks(int $failing_checks) : self
Parameters
- $failing_checks : int
-
failing_checks
Return values
self —setHealthScore()
Sets health_score
public
setHealthScore(int $health_score) : self
Parameters
- $health_score : int
-
health_score
Return values
self —setInsights()
Sets insights
public
setInsights(array<string|int, string> $insights) : self
Parameters
- $insights : array<string|int, string>
-
insights
Return values
self —setMtaSts()
Sets mta_sts
public
setMtaSts(LookupMtaStsDomainResults $mta_sts) : self
Parameters
- $mta_sts : LookupMtaStsDomainResults
-
mta_sts
Return values
self —setMx()
Sets mx
public
setMx(LookupMxRecordsResults $mx) : self
Parameters
- $mx : LookupMxRecordsResults
-
mx
Return values
self —setPassingChecks()
Sets passing_checks
public
setPassingChecks(int $passing_checks) : self
Parameters
- $passing_checks : int
-
passing_checks
Return values
self —setScoreScope()
Sets score_scope
public
setScoreScope(string $score_scope) : self
Parameters
- $score_scope : string
-
score_scope
Return values
self —setScoreVersion()
Sets score_version
public
setScoreVersion(string $score_version) : self
Parameters
- $score_version : string
-
score_version
Return values
self —setSpf()
Sets spf
public
setSpf(LookupSpfDomainResults $spf) : self
Parameters
- $spf : LookupSpfDomainResults
-
spf
Return values
self —setStatus()
Sets status
public
setStatus(string $status) : self
Parameters
- $status : string
-
status
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> —setTlsReporting()
Sets tls_reporting
public
setTlsReporting(LookupTlsReportingDomainResults $tls_reporting) : self
Parameters
- $tls_reporting : LookupTlsReportingDomainResults
-
tls_reporting
Return values
self —setTotalChecks()
Sets total_checks
public
setTotalChecks(int $total_checks) : self
Parameters
- $total_checks : int
-
total_checks
Return values
self —setWarnings()
Sets warnings
public
setWarnings(array<string|int, string> $warnings) : self
Parameters
- $warnings : array<string|int, string>
-
warnings
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>