AnalyzeDmarcReportResults
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
AnalyzeDmarcReportResults 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
- getDkimAlignedCount() : int
- Gets dkim_aligned_count
- getErrors() : array<string|int, string>
- Gets errors
- getFailedAlignmentCount() : int
- Gets failed_alignment_count
- getFullyAlignedCount() : int
- Gets fully_aligned_count
- getMetadata() : DmarcReportMetadata
- Gets metadata
- getModelName() : string
- The original name of the model.
- getNoneCount() : int
- Gets none_count
- getQuarantineCount() : int
- Gets quarantine_count
- getRecordCount() : int
- Gets record_count
- getRejectCount() : int
- Gets reject_count
- getSpfAlignedCount() : int
- Gets spf_aligned_count
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTopSources() : array<string|int, DmarcReportSourceSummary>
- Gets top_sources
- getTotalMessages() : int
- Gets total_messages
- 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
- setDkimAlignedCount() : self
- Sets dkim_aligned_count
- setErrors() : self
- Sets errors
- setFailedAlignmentCount() : self
- Sets failed_alignment_count
- setFullyAlignedCount() : self
- Sets fully_aligned_count
- setMetadata() : self
- Sets metadata
- setNoneCount() : self
- Sets none_count
- setQuarantineCount() : self
- Sets quarantine_count
- setRecordCount() : self
- Sets record_count
- setRejectCount() : self
- Sets reject_count
- setSpfAlignedCount() : self
- Sets spf_aligned_count
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTopSources() : self
- Sets top_sources
- setTotalMessages() : self
- Sets total_messages
- 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
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
= ['metadata' => 'metadata', 'record_count' => 'recordCount', 'total_messages' => 'totalMessages', 'reject_count' => 'rejectCount', 'quarantine_count' => 'quarantineCount', 'none_count' => 'noneCount', 'dkim_aligned_count' => 'dkimAlignedCount', 'spf_aligned_count' => 'spfAlignedCount', 'fully_aligned_count' => 'fullyAlignedCount', 'failed_alignment_count' => 'failedAlignmentCount', 'top_sources' => 'topSources', 'warnings' => 'warnings', 'errors' => 'errors']
$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
= ['metadata' => 'getMetadata', 'record_count' => 'getRecordCount', 'total_messages' => 'getTotalMessages', 'reject_count' => 'getRejectCount', 'quarantine_count' => 'getQuarantineCount', 'none_count' => 'getNoneCount', 'dkim_aligned_count' => 'getDkimAlignedCount', 'spf_aligned_count' => 'getSpfAlignedCount', 'fully_aligned_count' => 'getFullyAlignedCount', 'failed_alignment_count' => 'getFailedAlignmentCount', 'top_sources' => 'getTopSources', 'warnings' => 'getWarnings', 'errors' => 'getErrors']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['metadata' => null, 'record_count' => 'int32', 'total_messages' => 'int32', 'reject_count' => 'int32', 'quarantine_count' => 'int32', 'none_count' => 'int32', 'dkim_aligned_count' => 'int32', 'spf_aligned_count' => 'int32', 'fully_aligned_count' => 'int32', 'failed_alignment_count' => 'int32', 'top_sources' => null, 'warnings' => null, 'errors' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'AnalyzeDmarcReportResults'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['metadata' => false, 'record_count' => false, 'total_messages' => false, 'reject_count' => false, 'quarantine_count' => false, 'none_count' => false, 'dkim_aligned_count' => false, 'spf_aligned_count' => false, 'fully_aligned_count' => false, 'failed_alignment_count' => false, 'top_sources' => false, 'warnings' => false, 'errors' => 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
= ['metadata' => '\\MailSlurp\\Models\\DmarcReportMetadata', 'record_count' => 'int', 'total_messages' => 'int', 'reject_count' => 'int', 'quarantine_count' => 'int', 'none_count' => 'int', 'dkim_aligned_count' => 'int', 'spf_aligned_count' => 'int', 'fully_aligned_count' => 'int', 'failed_alignment_count' => 'int', 'top_sources' => '\\MailSlurp\\Models\\DmarcReportSourceSummary[]', 'warnings' => 'string[]', 'errors' => 'string[]']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['metadata' => 'setMetadata', 'record_count' => 'setRecordCount', 'total_messages' => 'setTotalMessages', 'reject_count' => 'setRejectCount', 'quarantine_count' => 'setQuarantineCount', 'none_count' => 'setNoneCount', 'dkim_aligned_count' => 'setDkimAlignedCount', 'spf_aligned_count' => 'setSpfAlignedCount', 'fully_aligned_count' => 'setFullyAlignedCount', 'failed_alignment_count' => 'setFailedAlignmentCount', 'top_sources' => 'setTopSources', 'warnings' => 'setWarnings', 'errors' => 'setErrors']
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> —getDkimAlignedCount()
Gets dkim_aligned_count
public
getDkimAlignedCount() : int
Return values
int —getErrors()
Gets errors
public
getErrors() : array<string|int, string>
Return values
array<string|int, string> —getFailedAlignmentCount()
Gets failed_alignment_count
public
getFailedAlignmentCount() : int
Return values
int —getFullyAlignedCount()
Gets fully_aligned_count
public
getFullyAlignedCount() : int
Return values
int —getMetadata()
Gets metadata
public
getMetadata() : DmarcReportMetadata
Return values
DmarcReportMetadata —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getNoneCount()
Gets none_count
public
getNoneCount() : int
Return values
int —getQuarantineCount()
Gets quarantine_count
public
getQuarantineCount() : int
Return values
int —getRecordCount()
Gets record_count
public
getRecordCount() : int
Return values
int —getRejectCount()
Gets reject_count
public
getRejectCount() : int
Return values
int —getSpfAlignedCount()
Gets spf_aligned_count
public
getSpfAlignedCount() : int
Return values
int —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTopSources()
Gets top_sources
public
getTopSources() : array<string|int, DmarcReportSourceSummary>
Return values
array<string|int, DmarcReportSourceSummary> —getTotalMessages()
Gets total_messages
public
getTotalMessages() : 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> —setDkimAlignedCount()
Sets dkim_aligned_count
public
setDkimAlignedCount(int $dkim_aligned_count) : self
Parameters
- $dkim_aligned_count : int
-
dkim_aligned_count
Return values
self —setErrors()
Sets errors
public
setErrors(array<string|int, string> $errors) : self
Parameters
- $errors : array<string|int, string>
-
errors
Return values
self —setFailedAlignmentCount()
Sets failed_alignment_count
public
setFailedAlignmentCount(int $failed_alignment_count) : self
Parameters
- $failed_alignment_count : int
-
failed_alignment_count
Return values
self —setFullyAlignedCount()
Sets fully_aligned_count
public
setFullyAlignedCount(int $fully_aligned_count) : self
Parameters
- $fully_aligned_count : int
-
fully_aligned_count
Return values
self —setMetadata()
Sets metadata
public
setMetadata(DmarcReportMetadata $metadata) : self
Parameters
- $metadata : DmarcReportMetadata
-
metadata
Return values
self —setNoneCount()
Sets none_count
public
setNoneCount(int $none_count) : self
Parameters
- $none_count : int
-
none_count
Return values
self —setQuarantineCount()
Sets quarantine_count
public
setQuarantineCount(int $quarantine_count) : self
Parameters
- $quarantine_count : int
-
quarantine_count
Return values
self —setRecordCount()
Sets record_count
public
setRecordCount(int $record_count) : self
Parameters
- $record_count : int
-
record_count
Return values
self —setRejectCount()
Sets reject_count
public
setRejectCount(int $reject_count) : self
Parameters
- $reject_count : int
-
reject_count
Return values
self —setSpfAlignedCount()
Sets spf_aligned_count
public
setSpfAlignedCount(int $spf_aligned_count) : self
Parameters
- $spf_aligned_count : int
-
spf_aligned_count
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> —setTopSources()
Sets top_sources
public
setTopSources(array<string|int, DmarcReportSourceSummary> $top_sources) : self
Parameters
- $top_sources : array<string|int, DmarcReportSourceSummary>
-
top_sources
Return values
self —setTotalMessages()
Sets total_messages
public
setTotalMessages(int $total_messages) : self
Parameters
- $total_messages : int
-
total_messages
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>