Documentation

EmailAuditAnalysisResult
in package
implements ModelInterface, ArrayAccess, JsonSerializable

EmailAuditAnalysisResult Class Doc Comment

Tags
category

Class

description

Combined email audit analysis across validation, client support, links, and images

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
STATUS_FAILED  = 'FAILED'
STATUS_HEALTHY  = 'HEALTHY'
STATUS_WARNING  = 'WARNING'
$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
getAttachmentMentionIssueCount()  : int
Gets attachment_mention_issue_count
getBrokenImages()  : array<string|int, EmailAuditUrlIssue>
Gets broken_images
getBrokenLinks()  : array<string|int, EmailAuditUrlIssue>
Gets broken_links
getCheckedImages()  : int
Gets checked_images
getCheckedLinks()  : int
Gets checked_links
getCompatibilityNotSupportedCount()  : int
Gets compatibility_not_supported_count
getCompatibilityUnknownCount()  : int
Gets compatibility_unknown_count
getCompatibilityWarningCount()  : int
Gets compatibility_warning_count
getContentReview()  : array<string|int, EmailAuditCheck>|null
Gets content_review
getDetectedImages()  : int
Gets detected_images
getDetectedLinks()  : int
Gets detected_links
getDkimVerdict()  : string|null
Gets dkim_verdict
getDmarcVerdict()  : string|null
Gets dmarc_verdict
getErrorMessage()  : string|null
Gets error_message
getExternalCheckSkippedCount()  : int
Gets external_check_skipped_count
getFailingChecks()  : int
Gets failing_checks
getFeatureSupport()  : EmailAuditAnalysisResultFeatureSupport|null
Gets feature_support
getHealthScore()  : int
Gets health_score
getHtmlErrorCount()  : int
Gets html_error_count
getHtmlInfoCount()  : int
Gets html_info_count
getHtmlValidation()  : EmailAuditAnalysisResultHtmlValidation|null
Gets html_validation
getHtmlWarningCount()  : int
Gets html_warning_count
getImageIssueCount()  : int
Gets image_issue_count
getInsights()  : array<string|int, string>
Gets insights
getLinkIssueCount()  : int
Gets link_issue_count
getModelName()  : string
The original name of the model.
getPassingChecks()  : int
Gets passing_checks
getReputationFailureCount()  : int
Gets reputation_failure_count
getSpamVerdict()  : string|null
Gets spam_verdict
getSpellingIssueCount()  : int
Gets spelling_issue_count
getSpellingIssues()  : array<string|int, EmailAuditSpellingIssue>
Gets spelling_issues
getSpfVerdict()  : string|null
Gets spf_verdict
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)
getTotalChecks()  : int
Gets total_checks
getVirusVerdict()  : string|null
Gets virus_verdict
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
setAttachmentMentionIssueCount()  : self
Sets attachment_mention_issue_count
setBrokenImages()  : self
Sets broken_images
setBrokenLinks()  : self
Sets broken_links
setCheckedImages()  : self
Sets checked_images
setCheckedLinks()  : self
Sets checked_links
setCompatibilityNotSupportedCount()  : self
Sets compatibility_not_supported_count
setCompatibilityUnknownCount()  : self
Sets compatibility_unknown_count
setCompatibilityWarningCount()  : self
Sets compatibility_warning_count
setContentReview()  : self
Sets content_review
setDetectedImages()  : self
Sets detected_images
setDetectedLinks()  : self
Sets detected_links
setDkimVerdict()  : self
Sets dkim_verdict
setDmarcVerdict()  : self
Sets dmarc_verdict
setErrorMessage()  : self
Sets error_message
setExternalCheckSkippedCount()  : self
Sets external_check_skipped_count
setFailingChecks()  : self
Sets failing_checks
setFeatureSupport()  : self
Sets feature_support
setHealthScore()  : self
Sets health_score
setHtmlErrorCount()  : self
Sets html_error_count
setHtmlInfoCount()  : self
Sets html_info_count
setHtmlValidation()  : self
Sets html_validation
setHtmlWarningCount()  : self
Sets html_warning_count
setImageIssueCount()  : self
Sets image_issue_count
setInsights()  : self
Sets insights
setLinkIssueCount()  : self
Sets link_issue_count
setPassingChecks()  : self
Sets passing_checks
setReputationFailureCount()  : self
Sets reputation_failure_count
setSpamVerdict()  : self
Sets spam_verdict
setSpellingIssueCount()  : self
Sets spelling_issue_count
setSpellingIssues()  : self
Sets spelling_issues
setSpfVerdict()  : self
Sets spf_verdict
setStatus()  : self
Sets status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTotalChecks()  : self
Sets total_checks
setVirusVerdict()  : self
Sets virus_verdict
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 = ['content_review' => 'contentReview', 'status' => 'status', 'health_score' => 'healthScore', 'total_checks' => 'totalChecks', 'passing_checks' => 'passingChecks', 'failing_checks' => 'failingChecks', 'detected_links' => 'detectedLinks', 'checked_links' => 'checkedLinks', 'detected_images' => 'detectedImages', 'checked_images' => 'checkedImages', 'link_issue_count' => 'linkIssueCount', 'image_issue_count' => 'imageIssueCount', 'spelling_issue_count' => 'spellingIssueCount', 'broken_links' => 'brokenLinks', 'broken_images' => 'brokenImages', 'spelling_issues' => 'spellingIssues', 'compatibility_warning_count' => 'compatibilityWarningCount', 'compatibility_not_supported_count' => 'compatibilityNotSupportedCount', 'compatibility_unknown_count' => 'compatibilityUnknownCount', 'feature_support' => 'featureSupport', 'html_error_count' => 'htmlErrorCount', 'html_warning_count' => 'htmlWarningCount', 'html_info_count' => 'htmlInfoCount', 'html_validation' => 'htmlValidation', 'reputation_failure_count' => 'reputationFailureCount', 'attachment_mention_issue_count' => 'attachmentMentionIssueCount', 'external_check_skipped_count' => 'externalCheckSkippedCount', 'insights' => 'insights', 'error_message' => 'errorMessage', 'spam_verdict' => 'spamVerdict', 'virus_verdict' => 'virusVerdict', 'spf_verdict' => 'spfVerdict', 'dkim_verdict' => 'dkimVerdict', 'dmarc_verdict' => 'dmarcVerdict']

$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 = ['content_review' => 'getContentReview', 'status' => 'getStatus', 'health_score' => 'getHealthScore', 'total_checks' => 'getTotalChecks', 'passing_checks' => 'getPassingChecks', 'failing_checks' => 'getFailingChecks', 'detected_links' => 'getDetectedLinks', 'checked_links' => 'getCheckedLinks', 'detected_images' => 'getDetectedImages', 'checked_images' => 'getCheckedImages', 'link_issue_count' => 'getLinkIssueCount', 'image_issue_count' => 'getImageIssueCount', 'spelling_issue_count' => 'getSpellingIssueCount', 'broken_links' => 'getBrokenLinks', 'broken_images' => 'getBrokenImages', 'spelling_issues' => 'getSpellingIssues', 'compatibility_warning_count' => 'getCompatibilityWarningCount', 'compatibility_not_supported_count' => 'getCompatibilityNotSupportedCount', 'compatibility_unknown_count' => 'getCompatibilityUnknownCount', 'feature_support' => 'getFeatureSupport', 'html_error_count' => 'getHtmlErrorCount', 'html_warning_count' => 'getHtmlWarningCount', 'html_info_count' => 'getHtmlInfoCount', 'html_validation' => 'getHtmlValidation', 'reputation_failure_count' => 'getReputationFailureCount', 'attachment_mention_issue_count' => 'getAttachmentMentionIssueCount', 'external_check_skipped_count' => 'getExternalCheckSkippedCount', 'insights' => 'getInsights', 'error_message' => 'getErrorMessage', 'spam_verdict' => 'getSpamVerdict', 'virus_verdict' => 'getVirusVerdict', 'spf_verdict' => 'getSpfVerdict', 'dkim_verdict' => 'getDkimVerdict', 'dmarc_verdict' => 'getDmarcVerdict']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['content_review' => null, 'status' => null, 'health_score' => 'int32', 'total_checks' => 'int32', 'passing_checks' => 'int32', 'failing_checks' => 'int32', 'detected_links' => 'int32', 'checked_links' => 'int32', 'detected_images' => 'int32', 'checked_images' => 'int32', 'link_issue_count' => 'int32', 'image_issue_count' => 'int32', 'spelling_issue_count' => 'int32', 'broken_links' => null, 'broken_images' => null, 'spelling_issues' => null, 'compatibility_warning_count' => 'int32', 'compatibility_not_supported_count' => 'int32', 'compatibility_unknown_count' => 'int32', 'feature_support' => null, 'html_error_count' => 'int32', 'html_warning_count' => 'int32', 'html_info_count' => 'int32', 'html_validation' => null, 'reputation_failure_count' => 'int32', 'attachment_mention_issue_count' => 'int32', 'external_check_skipped_count' => 'int32', 'insights' => null, 'error_message' => null, 'spam_verdict' => null, 'virus_verdict' => null, 'spf_verdict' => null, 'dkim_verdict' => null, 'dmarc_verdict' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'EmailAuditAnalysisResult'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['content_review' => true, 'status' => false, 'health_score' => false, 'total_checks' => false, 'passing_checks' => false, 'failing_checks' => false, 'detected_links' => false, 'checked_links' => false, 'detected_images' => false, 'checked_images' => false, 'link_issue_count' => false, 'image_issue_count' => false, 'spelling_issue_count' => false, 'broken_links' => false, 'broken_images' => false, 'spelling_issues' => false, 'compatibility_warning_count' => false, 'compatibility_not_supported_count' => false, 'compatibility_unknown_count' => false, 'feature_support' => true, 'html_error_count' => false, 'html_warning_count' => false, 'html_info_count' => false, 'html_validation' => true, 'reputation_failure_count' => false, 'attachment_mention_issue_count' => false, 'external_check_skipped_count' => false, 'insights' => false, 'error_message' => true, 'spam_verdict' => true, 'virus_verdict' => true, 'spf_verdict' => true, 'dkim_verdict' => true, 'dmarc_verdict' => 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 = ['content_review' => '\\MailSlurp\\Models\\EmailAuditCheck[]', 'status' => 'string', 'health_score' => 'int', 'total_checks' => 'int', 'passing_checks' => 'int', 'failing_checks' => 'int', 'detected_links' => 'int', 'checked_links' => 'int', 'detected_images' => 'int', 'checked_images' => 'int', 'link_issue_count' => 'int', 'image_issue_count' => 'int', 'spelling_issue_count' => 'int', 'broken_links' => '\\MailSlurp\\Models\\EmailAuditUrlIssue[]', 'broken_images' => '\\MailSlurp\\Models\\EmailAuditUrlIssue[]', 'spelling_issues' => '\\MailSlurp\\Models\\EmailAuditSpellingIssue[]', 'compatibility_warning_count' => 'int', 'compatibility_not_supported_count' => 'int', 'compatibility_unknown_count' => 'int', 'feature_support' => '\\MailSlurp\\Models\\EmailAuditAnalysisResultFeatureSupport', 'html_error_count' => 'int', 'html_warning_count' => 'int', 'html_info_count' => 'int', 'html_validation' => '\\MailSlurp\\Models\\EmailAuditAnalysisResultHtmlValidation', 'reputation_failure_count' => 'int', 'attachment_mention_issue_count' => 'int', 'external_check_skipped_count' => 'int', 'insights' => 'string[]', 'error_message' => 'string', 'spam_verdict' => 'string', 'virus_verdict' => 'string', 'spf_verdict' => 'string', 'dkim_verdict' => 'string', 'dmarc_verdict' => 'string']

$setters

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

protected static array<string|int, string> $setters = ['content_review' => 'setContentReview', 'status' => 'setStatus', 'health_score' => 'setHealthScore', 'total_checks' => 'setTotalChecks', 'passing_checks' => 'setPassingChecks', 'failing_checks' => 'setFailingChecks', 'detected_links' => 'setDetectedLinks', 'checked_links' => 'setCheckedLinks', 'detected_images' => 'setDetectedImages', 'checked_images' => 'setCheckedImages', 'link_issue_count' => 'setLinkIssueCount', 'image_issue_count' => 'setImageIssueCount', 'spelling_issue_count' => 'setSpellingIssueCount', 'broken_links' => 'setBrokenLinks', 'broken_images' => 'setBrokenImages', 'spelling_issues' => 'setSpellingIssues', 'compatibility_warning_count' => 'setCompatibilityWarningCount', 'compatibility_not_supported_count' => 'setCompatibilityNotSupportedCount', 'compatibility_unknown_count' => 'setCompatibilityUnknownCount', 'feature_support' => 'setFeatureSupport', 'html_error_count' => 'setHtmlErrorCount', 'html_warning_count' => 'setHtmlWarningCount', 'html_info_count' => 'setHtmlInfoCount', 'html_validation' => 'setHtmlValidation', 'reputation_failure_count' => 'setReputationFailureCount', 'attachment_mention_issue_count' => 'setAttachmentMentionIssueCount', 'external_check_skipped_count' => 'setExternalCheckSkippedCount', 'insights' => 'setInsights', 'error_message' => 'setErrorMessage', 'spam_verdict' => 'setSpamVerdict', 'virus_verdict' => 'setVirusVerdict', 'spf_verdict' => 'setSpfVerdict', 'dkim_verdict' => 'setDkimVerdict', 'dmarc_verdict' => 'setDmarcVerdict']

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> —

getAttachmentMentionIssueCount()

Gets attachment_mention_issue_count

public getAttachmentMentionIssueCount() : int
Return values
int —

getCompatibilityNotSupportedCount()

Gets compatibility_not_supported_count

public getCompatibilityNotSupportedCount() : int
Return values
int —

getCompatibilityUnknownCount()

Gets compatibility_unknown_count

public getCompatibilityUnknownCount() : int
Return values
int —

getCompatibilityWarningCount()

Gets compatibility_warning_count

public getCompatibilityWarningCount() : int
Return values
int —

getDkimVerdict()

Gets dkim_verdict

public getDkimVerdict() : string|null
Return values
string|null —

getDmarcVerdict()

Gets dmarc_verdict

public getDmarcVerdict() : string|null
Return values
string|null —

getErrorMessage()

Gets error_message

public getErrorMessage() : string|null
Return values
string|null —

getExternalCheckSkippedCount()

Gets external_check_skipped_count

public getExternalCheckSkippedCount() : int
Return values
int —

getHtmlWarningCount()

Gets html_warning_count

public getHtmlWarningCount() : int
Return values
int —

getInsights()

Gets insights

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

getReputationFailureCount()

Gets reputation_failure_count

public getReputationFailureCount() : int
Return values
int —

getSpamVerdict()

Gets spam_verdict

public getSpamVerdict() : string|null
Return values
string|null —

getSpellingIssueCount()

Gets spelling_issue_count

public getSpellingIssueCount() : int
Return values
int —

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> —

getVirusVerdict()

Gets virus_verdict

public getVirusVerdict() : string|null
Return values
string|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 —

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> —

setAttachmentMentionIssueCount()

Sets attachment_mention_issue_count

public setAttachmentMentionIssueCount(int $attachment_mention_issue_count) : self
Parameters
$attachment_mention_issue_count : int

attachment_mention_issue_count

Return values
self —

setCheckedImages()

Sets checked_images

public setCheckedImages(int $checked_images) : self
Parameters
$checked_images : int

checked_images

Return values
self —

setCheckedLinks()

Sets checked_links

public setCheckedLinks(int $checked_links) : self
Parameters
$checked_links : int

checked_links

Return values
self —

setCompatibilityNotSupportedCount()

Sets compatibility_not_supported_count

public setCompatibilityNotSupportedCount(int $compatibility_not_supported_count) : self
Parameters
$compatibility_not_supported_count : int

compatibility_not_supported_count

Return values
self —

setCompatibilityUnknownCount()

Sets compatibility_unknown_count

public setCompatibilityUnknownCount(int $compatibility_unknown_count) : self
Parameters
$compatibility_unknown_count : int

compatibility_unknown_count

Return values
self —

setCompatibilityWarningCount()

Sets compatibility_warning_count

public setCompatibilityWarningCount(int $compatibility_warning_count) : self
Parameters
$compatibility_warning_count : int

compatibility_warning_count

Return values
self —

setContentReview()

Sets content_review

public setContentReview(array<string|int, EmailAuditCheck>|null $content_review) : self
Parameters
$content_review : array<string|int, EmailAuditCheck>|null

Versioned static accessibility, unresolved template, and compliance review checks. Null on historical audits that did not run these checks.

Return values
self —

setDetectedImages()

Sets detected_images

public setDetectedImages(int $detected_images) : self
Parameters
$detected_images : int

detected_images

Return values
self —

setDetectedLinks()

Sets detected_links

public setDetectedLinks(int $detected_links) : self
Parameters
$detected_links : int

detected_links

Return values
self —

setDkimVerdict()

Sets dkim_verdict

public setDkimVerdict(string|null $dkim_verdict) : self
Parameters
$dkim_verdict : string|null

DKIM verdict supplied by the source mail receiver

Return values
self —

setDmarcVerdict()

Sets dmarc_verdict

public setDmarcVerdict(string|null $dmarc_verdict) : self
Parameters
$dmarc_verdict : string|null

DMARC verdict supplied by the source mail receiver

Return values
self —

setErrorMessage()

Sets error_message

public setErrorMessage(string|null $error_message) : self
Parameters
$error_message : string|null

error_message

Return values
self —

setExternalCheckSkippedCount()

Sets external_check_skipped_count

public setExternalCheckSkippedCount(int $external_check_skipped_count) : self
Parameters
$external_check_skipped_count : int

external_check_skipped_count

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 —

setHtmlErrorCount()

Sets html_error_count

public setHtmlErrorCount(int $html_error_count) : self
Parameters
$html_error_count : int

html_error_count

Return values
self —

setHtmlInfoCount()

Sets html_info_count

public setHtmlInfoCount(int $html_info_count) : self
Parameters
$html_info_count : int

html_info_count

Return values
self —

setHtmlWarningCount()

Sets html_warning_count

public setHtmlWarningCount(int $html_warning_count) : self
Parameters
$html_warning_count : int

html_warning_count

Return values
self —

setImageIssueCount()

Sets image_issue_count

public setImageIssueCount(int $image_issue_count) : self
Parameters
$image_issue_count : int

image_issue_count

Return values
self —

setInsights()

Sets insights

public setInsights(array<string|int, string> $insights) : self
Parameters
$insights : array<string|int, string>

insights

Return values
self —

setLinkIssueCount()

Sets link_issue_count

public setLinkIssueCount(int $link_issue_count) : self
Parameters
$link_issue_count : int

link_issue_count

Return values
self —

setPassingChecks()

Sets passing_checks

public setPassingChecks(int $passing_checks) : self
Parameters
$passing_checks : int

passing_checks

Return values
self —

setReputationFailureCount()

Sets reputation_failure_count

public setReputationFailureCount(int $reputation_failure_count) : self
Parameters
$reputation_failure_count : int

reputation_failure_count

Return values
self —

setSpamVerdict()

Sets spam_verdict

public setSpamVerdict(string|null $spam_verdict) : self
Parameters
$spam_verdict : string|null

Spam verdict supplied by the source mail receiver

Return values
self —

setSpellingIssueCount()

Sets spelling_issue_count

public setSpellingIssueCount(int $spelling_issue_count) : self
Parameters
$spelling_issue_count : int

spelling_issue_count

Return values
self —

setSpfVerdict()

Sets spf_verdict

public setSpfVerdict(string|null $spf_verdict) : self
Parameters
$spf_verdict : string|null

SPF verdict supplied by the source mail receiver

Return values
self —

setStatus()

Sets status

public setStatus(string $status) : self
Parameters
$status : string

Health status for a one-shot email audit

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> —

setTotalChecks()

Sets total_checks

public setTotalChecks(int $total_checks) : self
Parameters
$total_checks : int

total_checks

Return values
self —

setVirusVerdict()

Sets virus_verdict

public setVirusVerdict(string|null $virus_verdict) : self
Parameters
$virus_verdict : string|null

Virus verdict supplied by the source mail receiver

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