GenerateDmarcRecordOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
GenerateDmarcRecordOptions Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- ADKIM_RELAXED = 'RELAXED'
- ADKIM_STRICT = 'STRICT'
- ASPF_RELAXED = 'RELAXED'
- ASPF_STRICT = 'STRICT'
- DISCRIMINATOR = null
- FO__0 = 'FO_0'
- FO__1 = 'FO_1'
- FO_D = 'FO_D'
- FO_S = 'FO_S'
- POLICY_NONE = 'NONE'
- POLICY_QUARANTINE = 'QUARANTINE'
- POLICY_REJECT = 'REJECT'
- REPORT_FORMAT_AFRF = 'AFRF'
- SUBDOMAIN_POLICY_NONE = 'NONE'
- SUBDOMAIN_POLICY_QUARANTINE = 'QUARANTINE'
- SUBDOMAIN_POLICY_REJECT = 'REJECT'
- VERSION_DMARC1 = 'DMARC1'
- $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
- getAdkim() : string|null
- Gets adkim
- getAdkimAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getAspf() : string|null
- Gets aspf
- getAspfAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getDomain() : string
- Gets domain
- getFo() : string|null
- Gets fo
- getFoAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getForensicEmailAddress() : array<string|int, string>|null
- Gets forensic_email_address
- getModelName() : string
- The original name of the model.
- getPercentage() : int|null
- Gets percentage
- getPolicy() : string
- Gets policy
- getPolicyAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getReportEmailAddress() : array<string|int, string>|null
- Gets report_email_address
- getReportFormat() : string|null
- Gets report_format
- getReportFormatAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getSecondsBetweenReports() : int|null
- Gets seconds_between_reports
- getSubdomainPolicy() : string|null
- Gets subdomain_policy
- getSubdomainPolicyAllowableValues() : 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)
- getVersion() : string
- Gets version
- getVersionAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- 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
- setAdkim() : self
- Sets adkim
- setAspf() : self
- Sets aspf
- setDomain() : self
- Sets domain
- setFo() : self
- Sets fo
- setForensicEmailAddress() : self
- Sets forensic_email_address
- setPercentage() : self
- Sets percentage
- setPolicy() : self
- Sets policy
- setReportEmailAddress() : self
- Sets report_email_address
- setReportFormat() : self
- Sets report_format
- setSecondsBetweenReports() : self
- Sets seconds_between_reports
- setSubdomainPolicy() : self
- Sets subdomain_policy
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setVersion() : self
- Sets version
- 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
ADKIM_RELAXED
public
mixed
ADKIM_RELAXED
= 'RELAXED'
ADKIM_STRICT
public
mixed
ADKIM_STRICT
= 'STRICT'
ASPF_RELAXED
public
mixed
ASPF_RELAXED
= 'RELAXED'
ASPF_STRICT
public
mixed
ASPF_STRICT
= 'STRICT'
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
FO__0
public
mixed
FO__0
= 'FO_0'
FO__1
public
mixed
FO__1
= 'FO_1'
FO_D
public
mixed
FO_D
= 'FO_D'
FO_S
public
mixed
FO_S
= 'FO_S'
POLICY_NONE
public
mixed
POLICY_NONE
= 'NONE'
POLICY_QUARANTINE
public
mixed
POLICY_QUARANTINE
= 'QUARANTINE'
POLICY_REJECT
public
mixed
POLICY_REJECT
= 'REJECT'
REPORT_FORMAT_AFRF
public
mixed
REPORT_FORMAT_AFRF
= 'AFRF'
SUBDOMAIN_POLICY_NONE
public
mixed
SUBDOMAIN_POLICY_NONE
= 'NONE'
SUBDOMAIN_POLICY_QUARANTINE
public
mixed
SUBDOMAIN_POLICY_QUARANTINE
= 'QUARANTINE'
SUBDOMAIN_POLICY_REJECT
public
mixed
SUBDOMAIN_POLICY_REJECT
= 'REJECT'
VERSION_DMARC1
public
mixed
VERSION_DMARC1
= 'DMARC1'
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', 'version' => 'version', 'policy' => 'policy', 'subdomain_policy' => 'subdomainPolicy', 'report_email_address' => 'reportEmailAddress', 'forensic_email_address' => 'forensicEmailAddress', 'percentage' => 'percentage', 'report_format' => 'reportFormat', 'seconds_between_reports' => 'secondsBetweenReports', 'adkim' => 'adkim', 'aspf' => 'aspf', 'fo' => 'fo']
$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', 'version' => 'getVersion', 'policy' => 'getPolicy', 'subdomain_policy' => 'getSubdomainPolicy', 'report_email_address' => 'getReportEmailAddress', 'forensic_email_address' => 'getForensicEmailAddress', 'percentage' => 'getPercentage', 'report_format' => 'getReportFormat', 'seconds_between_reports' => 'getSecondsBetweenReports', 'adkim' => 'getAdkim', 'aspf' => 'getAspf', 'fo' => 'getFo']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['domain' => null, 'version' => null, 'policy' => null, 'subdomain_policy' => null, 'report_email_address' => null, 'forensic_email_address' => null, 'percentage' => 'int32', 'report_format' => null, 'seconds_between_reports' => 'int32', 'adkim' => null, 'aspf' => null, 'fo' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'GenerateDmarcRecordOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['domain' => false, 'version' => false, 'policy' => false, 'subdomain_policy' => false, 'report_email_address' => false, 'forensic_email_address' => false, 'percentage' => false, 'report_format' => false, 'seconds_between_reports' => false, 'adkim' => false, 'aspf' => false, 'fo' => 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', 'version' => 'string', 'policy' => 'string', 'subdomain_policy' => 'string', 'report_email_address' => 'string[]', 'forensic_email_address' => 'string[]', 'percentage' => 'int', 'report_format' => 'string', 'seconds_between_reports' => 'int', 'adkim' => 'string', 'aspf' => 'string', 'fo' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['domain' => 'setDomain', 'version' => 'setVersion', 'policy' => 'setPolicy', 'subdomain_policy' => 'setSubdomainPolicy', 'report_email_address' => 'setReportEmailAddress', 'forensic_email_address' => 'setForensicEmailAddress', 'percentage' => 'setPercentage', 'report_format' => 'setReportFormat', 'seconds_between_reports' => 'setSecondsBetweenReports', 'adkim' => 'setAdkim', 'aspf' => 'setAspf', 'fo' => 'setFo']
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> —getAdkim()
Gets adkim
public
getAdkim() : string|null
Return values
string|null —getAdkimAllowableValues()
Gets allowable values of the enum
public
getAdkimAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getAspf()
Gets aspf
public
getAspf() : string|null
Return values
string|null —getAspfAllowableValues()
Gets allowable values of the enum
public
getAspfAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getDomain()
Gets domain
public
getDomain() : string
Return values
string —getFo()
Gets fo
public
getFo() : string|null
Return values
string|null —getFoAllowableValues()
Gets allowable values of the enum
public
getFoAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getForensicEmailAddress()
Gets forensic_email_address
public
getForensicEmailAddress() : array<string|int, string>|null
Return values
array<string|int, string>|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPercentage()
Gets percentage
public
getPercentage() : int|null
Return values
int|null —getPolicy()
Gets policy
public
getPolicy() : string
Return values
string —getPolicyAllowableValues()
Gets allowable values of the enum
public
getPolicyAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getReportEmailAddress()
Gets report_email_address
public
getReportEmailAddress() : array<string|int, string>|null
Return values
array<string|int, string>|null —getReportFormat()
Gets report_format
public
getReportFormat() : string|null
Return values
string|null —getReportFormatAllowableValues()
Gets allowable values of the enum
public
getReportFormatAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getSecondsBetweenReports()
Gets seconds_between_reports
public
getSecondsBetweenReports() : int|null
Return values
int|null —getSubdomainPolicy()
Gets subdomain_policy
public
getSubdomainPolicy() : string|null
Return values
string|null —getSubdomainPolicyAllowableValues()
Gets allowable values of the enum
public
getSubdomainPolicyAllowableValues() : 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> —getVersion()
Gets version
public
getVersion() : string
Return values
string —getVersionAllowableValues()
Gets allowable values of the enum
public
getVersionAllowableValues() : 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> —setAdkim()
Sets adkim
public
setAdkim(string|null $adkim) : self
Parameters
- $adkim : string|null
-
adkim
Return values
self —setAspf()
Sets aspf
public
setAspf(string|null $aspf) : self
Parameters
- $aspf : string|null
-
aspf
Return values
self —setDomain()
Sets domain
public
setDomain(string $domain) : self
Parameters
- $domain : string
-
domain
Return values
self —setFo()
Sets fo
public
setFo(string|null $fo) : self
Parameters
- $fo : string|null
-
fo
Return values
self —setForensicEmailAddress()
Sets forensic_email_address
public
setForensicEmailAddress(array<string|int, string>|null $forensic_email_address) : self
Parameters
- $forensic_email_address : array<string|int, string>|null
-
forensic_email_address
Return values
self —setPercentage()
Sets percentage
public
setPercentage(int|null $percentage) : self
Parameters
- $percentage : int|null
-
percentage
Return values
self —setPolicy()
Sets policy
public
setPolicy(string $policy) : self
Parameters
- $policy : string
-
policy
Return values
self —setReportEmailAddress()
Sets report_email_address
public
setReportEmailAddress(array<string|int, string>|null $report_email_address) : self
Parameters
- $report_email_address : array<string|int, string>|null
-
report_email_address
Return values
self —setReportFormat()
Sets report_format
public
setReportFormat(string|null $report_format) : self
Parameters
- $report_format : string|null
-
report_format
Return values
self —setSecondsBetweenReports()
Sets seconds_between_reports
public
setSecondsBetweenReports(int|null $seconds_between_reports) : self
Parameters
- $seconds_between_reports : int|null
-
seconds_between_reports
Return values
self —setSubdomainPolicy()
Sets subdomain_policy
public
setSubdomainPolicy(string|null $subdomain_policy) : self
Parameters
- $subdomain_policy : string|null
-
subdomain_policy
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> —setVersion()
Sets version
public
setVersion(string $version) : self
Parameters
- $version : string
-
version
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>