CheckEmailBlacklistResults
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
CheckEmailBlacklistResults Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- CHECK_STATUS_ERROR = 'ERROR'
- CHECK_STATUS_LISTED = 'LISTED'
- CHECK_STATUS_NOT_CHECKED = 'NOT_CHECKED'
- CHECK_STATUS_NOT_LISTED = 'NOT_LISTED'
- 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
- getCheckedAt() : DateTime
- Gets checked_at
- getCheckedDomains() : array<string|int, EmailBlacklistDomainResult>
- Gets checked_domains
- getCheckedIpAddresses() : array<string|int, EmailBlacklistIpResult>
- Gets checked_ip_addresses
- getCheckedZoneCount() : int
- Gets checked_zone_count
- getCheckStatus() : string
- Gets check_status
- getCheckStatusAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getDomain() : string|null
- Gets domain
- getErrors() : array<string|int, string>
- Gets errors
- getEvidenceVersion() : string
- Gets evidence_version
- getListed() : bool
- Gets listed
- getModelName() : string
- The original name of the model.
- getRequestedIpAddress() : string|null
- Gets requested_ip_address
- getRequestedMxHost() : string|null
- Gets requested_mx_host
- 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)
- getTotalListings() : int
- Gets total_listings
- 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
- setCheckedAt() : self
- Sets checked_at
- setCheckedDomains() : self
- Sets checked_domains
- setCheckedIpAddresses() : self
- Sets checked_ip_addresses
- setCheckedZoneCount() : self
- Sets checked_zone_count
- setCheckStatus() : self
- Sets check_status
- setDomain() : self
- Sets domain
- setErrors() : self
- Sets errors
- setEvidenceVersion() : self
- Sets evidence_version
- setListed() : self
- Sets listed
- setRequestedIpAddress() : self
- Sets requested_ip_address
- setRequestedMxHost() : self
- Sets requested_mx_host
- setStatus() : self
- Sets status
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTotalListings() : self
- Sets total_listings
- 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
CHECK_STATUS_ERROR
public
mixed
CHECK_STATUS_ERROR
= 'ERROR'
CHECK_STATUS_LISTED
public
mixed
CHECK_STATUS_LISTED
= 'LISTED'
CHECK_STATUS_NOT_CHECKED
public
mixed
CHECK_STATUS_NOT_CHECKED
= 'NOT_CHECKED'
CHECK_STATUS_NOT_LISTED
public
mixed
CHECK_STATUS_NOT_LISTED
= 'NOT_LISTED'
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', 'requested_ip_address' => 'requestedIpAddress', 'requested_mx_host' => 'requestedMxHost', 'status' => 'status', 'listed' => 'listed', 'checked_ip_addresses' => 'checkedIpAddresses', 'checked_zone_count' => 'checkedZoneCount', 'total_listings' => 'totalListings', 'warnings' => 'warnings', 'errors' => 'errors', 'check_status' => 'checkStatus', 'checked_domains' => 'checkedDomains', 'checked_at' => 'checkedAt', 'evidence_version' => 'evidenceVersion']
$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', 'requested_ip_address' => 'getRequestedIpAddress', 'requested_mx_host' => 'getRequestedMxHost', 'status' => 'getStatus', 'listed' => 'getListed', 'checked_ip_addresses' => 'getCheckedIpAddresses', 'checked_zone_count' => 'getCheckedZoneCount', 'total_listings' => 'getTotalListings', 'warnings' => 'getWarnings', 'errors' => 'getErrors', 'check_status' => 'getCheckStatus', 'checked_domains' => 'getCheckedDomains', 'checked_at' => 'getCheckedAt', 'evidence_version' => 'getEvidenceVersion']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['domain' => null, 'requested_ip_address' => null, 'requested_mx_host' => null, 'status' => null, 'listed' => null, 'checked_ip_addresses' => null, 'checked_zone_count' => 'int32', 'total_listings' => 'int32', 'warnings' => null, 'errors' => null, 'check_status' => null, 'checked_domains' => null, 'checked_at' => 'date-time', 'evidence_version' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'CheckEmailBlacklistResults'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['domain' => true, 'requested_ip_address' => true, 'requested_mx_host' => true, 'status' => false, 'listed' => false, 'checked_ip_addresses' => false, 'checked_zone_count' => false, 'total_listings' => false, 'warnings' => false, 'errors' => false, 'check_status' => false, 'checked_domains' => false, 'checked_at' => false, 'evidence_version' => 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', 'requested_ip_address' => 'string', 'requested_mx_host' => 'string', 'status' => 'string', 'listed' => 'bool', 'checked_ip_addresses' => '\\MailSlurp\\Models\\EmailBlacklistIpResult[]', 'checked_zone_count' => 'int', 'total_listings' => 'int', 'warnings' => 'string[]', 'errors' => 'string[]', 'check_status' => 'string', 'checked_domains' => '\\MailSlurp\\Models\\EmailBlacklistDomainResult[]', 'checked_at' => '\\DateTime', 'evidence_version' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['domain' => 'setDomain', 'requested_ip_address' => 'setRequestedIpAddress', 'requested_mx_host' => 'setRequestedMxHost', 'status' => 'setStatus', 'listed' => 'setListed', 'checked_ip_addresses' => 'setCheckedIpAddresses', 'checked_zone_count' => 'setCheckedZoneCount', 'total_listings' => 'setTotalListings', 'warnings' => 'setWarnings', 'errors' => 'setErrors', 'check_status' => 'setCheckStatus', 'checked_domains' => 'setCheckedDomains', 'checked_at' => 'setCheckedAt', 'evidence_version' => 'setEvidenceVersion']
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> —getCheckedAt()
Gets checked_at
public
getCheckedAt() : DateTime
Return values
DateTime —getCheckedDomains()
Gets checked_domains
public
getCheckedDomains() : array<string|int, EmailBlacklistDomainResult>
Return values
array<string|int, EmailBlacklistDomainResult> —getCheckedIpAddresses()
Gets checked_ip_addresses
public
getCheckedIpAddresses() : array<string|int, EmailBlacklistIpResult>
Return values
array<string|int, EmailBlacklistIpResult> —getCheckedZoneCount()
Gets checked_zone_count
public
getCheckedZoneCount() : int
Return values
int —getCheckStatus()
Gets check_status
public
getCheckStatus() : string
Return values
string —getCheckStatusAllowableValues()
Gets allowable values of the enum
public
getCheckStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getDomain()
Gets domain
public
getDomain() : string|null
Return values
string|null —getErrors()
Gets errors
public
getErrors() : array<string|int, string>
Return values
array<string|int, string> —getEvidenceVersion()
Gets evidence_version
public
getEvidenceVersion() : string
Return values
string —getListed()
Gets listed
public
getListed() : bool
Return values
bool —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getRequestedIpAddress()
Gets requested_ip_address
public
getRequestedIpAddress() : string|null
Return values
string|null —getRequestedMxHost()
Gets requested_mx_host
public
getRequestedMxHost() : string|null
Return values
string|null —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> —getTotalListings()
Gets total_listings
public
getTotalListings() : 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> —setCheckedAt()
Sets checked_at
public
setCheckedAt(DateTime $checked_at) : self
Parameters
- $checked_at : DateTime
-
checked_at
Return values
self —setCheckedDomains()
Sets checked_domains
public
setCheckedDomains(array<string|int, EmailBlacklistDomainResult> $checked_domains) : self
Parameters
- $checked_domains : array<string|int, EmailBlacklistDomainResult>
-
checked_domains
Return values
self —setCheckedIpAddresses()
Sets checked_ip_addresses
public
setCheckedIpAddresses(array<string|int, EmailBlacklistIpResult> $checked_ip_addresses) : self
Parameters
- $checked_ip_addresses : array<string|int, EmailBlacklistIpResult>
-
checked_ip_addresses
Return values
self —setCheckedZoneCount()
Sets checked_zone_count
public
setCheckedZoneCount(int $checked_zone_count) : self
Parameters
- $checked_zone_count : int
-
checked_zone_count
Return values
self —setCheckStatus()
Sets check_status
public
setCheckStatus(string $check_status) : self
Parameters
- $check_status : string
-
check_status
Return values
self —setDomain()
Sets domain
public
setDomain(string|null $domain) : self
Parameters
- $domain : string|null
-
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 —setEvidenceVersion()
Sets evidence_version
public
setEvidenceVersion(string $evidence_version) : self
Parameters
- $evidence_version : string
-
evidence_version
Return values
self —setListed()
Sets listed
public
setListed(bool $listed) : self
Parameters
- $listed : bool
-
listed
Return values
self —setRequestedIpAddress()
Sets requested_ip_address
public
setRequestedIpAddress(string|null $requested_ip_address) : self
Parameters
- $requested_ip_address : string|null
-
requested_ip_address
Return values
self —setRequestedMxHost()
Sets requested_mx_host
public
setRequestedMxHost(string|null $requested_mx_host) : self
Parameters
- $requested_mx_host : string|null
-
requested_mx_host
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> —setTotalListings()
Sets total_listings
public
setTotalListings(int $total_listings) : self
Parameters
- $total_listings : int
-
total_listings
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>