Email
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
Email 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
- getAnalysis() : EmailAnalysis|null
- Gets analysis
- getAttachments() : array<string|int, string>|null
- Gets attachments
- getBcc() : array<string|int, string>|null
- Gets bcc
- getBody() : string|null
- Gets body
- getBodyExcerpt() : string|null
- Gets body_excerpt
- getBodyMd5Hash() : string|null
- Gets body_md5_hash
- getBodyPartContentTypes() : array<string|int, string>|null
- Gets body_part_content_types
- getCc() : array<string|int, string>|null
- Gets cc
- getCharset() : string|null
- Gets charset
- getCreatedAt() : DateTime
- Gets created_at
- getDomainId() : string|null
- Gets domain_id
- getFrom() : string|null
- Gets from
- getHeaders() : array<string, string>|null
- Gets headers
- getHeadersMap() : array<string, array<string|int, string>>|null
- Gets headers_map
- getHtml() : bool|null
- Gets html
- getId() : string
- Gets id
- getInboxId() : string
- Gets inbox_id
- getIsHtml() : bool|null
- Gets is_html
- getIsXAmpHtml() : bool|null
- Gets is_x_amp_html
- getModelName() : string
- The original name of the model.
- getRead() : bool
- Gets read
- getRecipients() : EmailRecipients|null
- Gets recipients
- getReplyTo() : string|null
- Gets reply_to
- getSender() : Sender|null
- Gets sender
- getSubject() : string|null
- Gets subject
- getTeamAccess() : bool
- Gets team_access
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTextExcerpt() : string|null
- Gets text_excerpt
- getTo() : array<string|int, string>
- Gets to
- getUpdatedAt() : DateTime
- Gets updated_at
- getUserId() : string
- Gets user_id
- getXampHtml() : bool|null
- Gets xamp_html
- 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
- setAnalysis() : self
- Sets analysis
- setAttachments() : self
- Sets attachments
- setBcc() : self
- Sets bcc
- setBody() : self
- Sets body
- setBodyExcerpt() : self
- Sets body_excerpt
- setBodyMd5Hash() : self
- Sets body_md5_hash
- setBodyPartContentTypes() : self
- Sets body_part_content_types
- setCc() : self
- Sets cc
- setCharset() : self
- Sets charset
- setCreatedAt() : self
- Sets created_at
- setDomainId() : self
- Sets domain_id
- setFrom() : self
- Sets from
- setHeaders() : self
- Sets headers
- setHeadersMap() : self
- Sets headers_map
- setHtml() : self
- Sets html
- setId() : self
- Sets id
- setInboxId() : self
- Sets inbox_id
- setIsHtml() : self
- Sets is_html
- setIsXAmpHtml() : self
- Sets is_x_amp_html
- setRead() : self
- Sets read
- setRecipients() : self
- Sets recipients
- setReplyTo() : self
- Sets reply_to
- setSender() : self
- Sets sender
- setSubject() : self
- Sets subject
- setTeamAccess() : self
- Sets team_access
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTextExcerpt() : self
- Sets text_excerpt
- setTo() : self
- Sets to
- setUpdatedAt() : self
- Sets updated_at
- setUserId() : self
- Sets user_id
- setXampHtml() : self
- Sets xamp_html
- 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
= ['id' => 'id', 'user_id' => 'userId', 'inbox_id' => 'inboxId', 'domain_id' => 'domainId', 'to' => 'to', 'from' => 'from', 'sender' => 'sender', 'recipients' => 'recipients', 'reply_to' => 'replyTo', 'cc' => 'cc', 'bcc' => 'bcc', 'headers' => 'headers', 'headers_map' => 'headersMap', 'attachments' => 'attachments', 'subject' => 'subject', 'body' => 'body', 'body_excerpt' => 'bodyExcerpt', 'text_excerpt' => 'textExcerpt', 'body_md5_hash' => 'bodyMD5Hash', 'is_html' => 'isHTML', 'charset' => 'charset', 'analysis' => 'analysis', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt', 'read' => 'read', 'team_access' => 'teamAccess', 'is_x_amp_html' => 'isXAmpHtml', 'body_part_content_types' => 'bodyPartContentTypes', 'html' => 'html', 'xamp_html' => 'xampHtml']
$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
= ['id' => 'getId', 'user_id' => 'getUserId', 'inbox_id' => 'getInboxId', 'domain_id' => 'getDomainId', 'to' => 'getTo', 'from' => 'getFrom', 'sender' => 'getSender', 'recipients' => 'getRecipients', 'reply_to' => 'getReplyTo', 'cc' => 'getCc', 'bcc' => 'getBcc', 'headers' => 'getHeaders', 'headers_map' => 'getHeadersMap', 'attachments' => 'getAttachments', 'subject' => 'getSubject', 'body' => 'getBody', 'body_excerpt' => 'getBodyExcerpt', 'text_excerpt' => 'getTextExcerpt', 'body_md5_hash' => 'getBodyMd5Hash', 'is_html' => 'getIsHtml', 'charset' => 'getCharset', 'analysis' => 'getAnalysis', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt', 'read' => 'getRead', 'team_access' => 'getTeamAccess', 'is_x_amp_html' => 'getIsXAmpHtml', 'body_part_content_types' => 'getBodyPartContentTypes', 'html' => 'getHtml', 'xamp_html' => 'getXampHtml']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['id' => 'uuid', 'user_id' => 'uuid', 'inbox_id' => 'uuid', 'domain_id' => 'uuid', 'to' => null, 'from' => null, 'sender' => null, 'recipients' => null, 'reply_to' => null, 'cc' => null, 'bcc' => null, 'headers' => null, 'headers_map' => null, 'attachments' => null, 'subject' => null, 'body' => null, 'body_excerpt' => null, 'text_excerpt' => null, 'body_md5_hash' => null, 'is_html' => null, 'charset' => null, 'analysis' => null, 'created_at' => 'date-time', 'updated_at' => 'date-time', 'read' => null, 'team_access' => null, 'is_x_amp_html' => null, 'body_part_content_types' => null, 'html' => null, 'xamp_html' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'Email'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'user_id' => false, 'inbox_id' => false, 'domain_id' => true, 'to' => false, 'from' => true, 'sender' => true, 'recipients' => true, 'reply_to' => true, 'cc' => true, 'bcc' => true, 'headers' => true, 'headers_map' => true, 'attachments' => true, 'subject' => true, 'body' => true, 'body_excerpt' => true, 'text_excerpt' => true, 'body_md5_hash' => true, 'is_html' => true, 'charset' => true, 'analysis' => true, 'created_at' => false, 'updated_at' => false, 'read' => false, 'team_access' => false, 'is_x_amp_html' => true, 'body_part_content_types' => true, 'html' => false, 'xamp_html' => 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
= ['id' => 'string', 'user_id' => 'string', 'inbox_id' => 'string', 'domain_id' => 'string', 'to' => 'string[]', 'from' => 'string', 'sender' => '\\MailSlurp\\Models\\Sender', 'recipients' => '\\MailSlurp\\Models\\EmailRecipients', 'reply_to' => 'string', 'cc' => 'string[]', 'bcc' => 'string[]', 'headers' => 'array<string,string>', 'headers_map' => 'array<string,string[]>', 'attachments' => 'string[]', 'subject' => 'string', 'body' => 'string', 'body_excerpt' => 'string', 'text_excerpt' => 'string', 'body_md5_hash' => 'string', 'is_html' => 'bool', 'charset' => 'string', 'analysis' => '\\MailSlurp\\Models\\EmailAnalysis', 'created_at' => '\\DateTime', 'updated_at' => '\\DateTime', 'read' => 'bool', 'team_access' => 'bool', 'is_x_amp_html' => 'bool', 'body_part_content_types' => 'string[]', 'html' => 'bool', 'xamp_html' => 'bool']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['id' => 'setId', 'user_id' => 'setUserId', 'inbox_id' => 'setInboxId', 'domain_id' => 'setDomainId', 'to' => 'setTo', 'from' => 'setFrom', 'sender' => 'setSender', 'recipients' => 'setRecipients', 'reply_to' => 'setReplyTo', 'cc' => 'setCc', 'bcc' => 'setBcc', 'headers' => 'setHeaders', 'headers_map' => 'setHeadersMap', 'attachments' => 'setAttachments', 'subject' => 'setSubject', 'body' => 'setBody', 'body_excerpt' => 'setBodyExcerpt', 'text_excerpt' => 'setTextExcerpt', 'body_md5_hash' => 'setBodyMd5Hash', 'is_html' => 'setIsHtml', 'charset' => 'setCharset', 'analysis' => 'setAnalysis', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt', 'read' => 'setRead', 'team_access' => 'setTeamAccess', 'is_x_amp_html' => 'setIsXAmpHtml', 'body_part_content_types' => 'setBodyPartContentTypes', 'html' => 'setHtml', 'xamp_html' => 'setXampHtml']
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> —getAnalysis()
Gets analysis
public
getAnalysis() : EmailAnalysis|null
Return values
EmailAnalysis|null —getAttachments()
Gets attachments
public
getAttachments() : array<string|int, string>|null
Return values
array<string|int, string>|null —getBcc()
Gets bcc
public
getBcc() : array<string|int, string>|null
Return values
array<string|int, string>|null —getBody()
Gets body
public
getBody() : string|null
Return values
string|null —getBodyExcerpt()
Gets body_excerpt
public
getBodyExcerpt() : string|null
Return values
string|null —getBodyMd5Hash()
Gets body_md5_hash
public
getBodyMd5Hash() : string|null
Return values
string|null —getBodyPartContentTypes()
Gets body_part_content_types
public
getBodyPartContentTypes() : array<string|int, string>|null
Return values
array<string|int, string>|null —getCc()
Gets cc
public
getCc() : array<string|int, string>|null
Return values
array<string|int, string>|null —getCharset()
Gets charset
public
getCharset() : string|null
Return values
string|null —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —getDomainId()
Gets domain_id
public
getDomainId() : string|null
Return values
string|null —getFrom()
Gets from
public
getFrom() : string|null
Return values
string|null —getHeaders()
Gets headers
public
getHeaders() : array<string, string>|null
Tags
Return values
array<string, string>|null —getHeadersMap()
Gets headers_map
public
getHeadersMap() : array<string, array<string|int, string>>|null
Return values
array<string, array<string|int, string>>|null —getHtml()
Gets html
public
getHtml() : bool|null
Return values
bool|null —getId()
Gets id
public
getId() : string
Return values
string —getInboxId()
Gets inbox_id
public
getInboxId() : string
Return values
string —getIsHtml()
Gets is_html
public
getIsHtml() : bool|null
Return values
bool|null —getIsXAmpHtml()
Gets is_x_amp_html
public
getIsXAmpHtml() : bool|null
Return values
bool|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getRead()
Gets read
public
getRead() : bool
Return values
bool —getRecipients()
Gets recipients
public
getRecipients() : EmailRecipients|null
Return values
EmailRecipients|null —getReplyTo()
Gets reply_to
public
getReplyTo() : string|null
Return values
string|null —getSender()
Gets sender
public
getSender() : Sender|null
Return values
Sender|null —getSubject()
Gets subject
public
getSubject() : string|null
Return values
string|null —getTeamAccess()
Gets team_access
public
getTeamAccess() : bool
Return values
bool —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTextExcerpt()
Gets text_excerpt
public
getTextExcerpt() : string|null
Return values
string|null —getTo()
Gets to
public
getTo() : array<string|int, string>
Return values
array<string|int, string> —getUpdatedAt()
Gets updated_at
public
getUpdatedAt() : DateTime
Return values
DateTime —getUserId()
Gets user_id
public
getUserId() : string
Return values
string —getXampHtml()
Gets xamp_html
public
getXampHtml() : bool|null
Return values
bool|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 —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> —setAnalysis()
Sets analysis
public
setAnalysis(EmailAnalysis|null $analysis) : self
Parameters
- $analysis : EmailAnalysis|null
-
analysis
Return values
self —setAttachments()
Sets attachments
public
setAttachments(array<string|int, string>|null $attachments) : self
Parameters
- $attachments : array<string|int, string>|null
-
List of IDs of attachments found in the email. Use these IDs with the Inbox and Email Controllers to download attachments and attachment meta data such as filesize, name, extension.
Return values
self —setBcc()
Sets bcc
public
setBcc(array<string|int, string>|null $bcc) : self
Parameters
- $bcc : array<string|int, string>|null
-
List of
BCC
recipients email addresses that the email was addressed to. See recipients object for names.
Return values
self —setBody()
Sets body
public
setBody(string|null $body) : self
Parameters
- $body : string|null
-
The body of the email message as text parsed from the SMTP message body (does not include attachments). Fetch the raw content to access the SMTP message and use the attachments property to access attachments. The body is stored separately to the email entity so the body is not returned in paginated results only in full single email or wait requests.
Return values
self —setBodyExcerpt()
Sets body_excerpt
public
setBodyExcerpt(string|null $body_excerpt) : self
Parameters
- $body_excerpt : string|null
-
An excerpt of the body of the email message for quick preview. Takes HTML content part if exists falls back to TEXT content part if not
Return values
self —setBodyMd5Hash()
Sets body_md5_hash
public
setBodyMd5Hash(string|null $body_md5_hash) : self
Parameters
- $body_md5_hash : string|null
-
A hash signature of the email message using MD5. Useful for comparing emails without fetching full body.
Return values
self —setBodyPartContentTypes()
Sets body_part_content_types
public
setBodyPartContentTypes(array<string|int, string>|null $body_part_content_types) : self
Parameters
- $body_part_content_types : array<string|int, string>|null
-
A list of detected multipart mime message body part content types such as text/plain and text/html. Can be used with email bodyPart endpoints to fetch individual body parts.
Return values
self —setCc()
Sets cc
public
setCc(array<string|int, string>|null $cc) : self
Parameters
- $cc : array<string|int, string>|null
-
List of
CC
recipients email addresses that the email was addressed to. See recipients object for names.
Return values
self —setCharset()
Sets charset
public
setCharset(string|null $charset) : self
Parameters
- $charset : string|null
-
Detected character set of the email body such as UTF-8
Return values
self —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
When was the email received by MailSlurp
Return values
self —setDomainId()
Sets domain_id
public
setDomainId(string|null $domain_id) : self
Parameters
- $domain_id : string|null
-
ID of the domain that received the email
Return values
self —setFrom()
Sets from
public
setFrom(string|null $from) : self
Parameters
- $from : string|null
-
Who the email was sent from. An email address - see fromName for the sender name.
Return values
self —setHeaders()
Sets headers
public
setHeaders(array<string, string>|null $headers) : self
Parameters
- $headers : array<string, string>|null
-
Collection of SMTP headers attached to email
Tags
Return values
self —setHeadersMap()
Sets headers_map
public
setHeadersMap(array<string, array<string|int, string>>|null $headers_map) : self
Parameters
- $headers_map : array<string, array<string|int, string>>|null
-
Multi-value map of SMTP headers attached to email
Return values
self —setHtml()
Sets html
public
setHtml(bool|null $html) : self
Parameters
- $html : bool|null
-
html
Return values
self —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
ID of the email entity
Return values
self —setInboxId()
Sets inbox_id
public
setInboxId(string $inbox_id) : self
Parameters
- $inbox_id : string
-
ID of the inbox that received the email
Return values
self —setIsHtml()
Sets is_html
public
setIsHtml(bool|null $is_html) : self
Parameters
- $is_html : bool|null
-
Is the email body content type HTML?
Return values
self —setIsXAmpHtml()
Sets is_x_amp_html
public
setIsXAmpHtml(bool|null $is_x_amp_html) : self
Parameters
- $is_x_amp_html : bool|null
-
Is the email body content type x-amp-html Amp4Email?
Return values
self —setRead()
Sets read
public
setRead(bool $read) : self
Parameters
- $read : bool
-
Read flag. Has the email ever been viewed in the dashboard or fetched via the API with a hydrated body? If so the email is marked as read. Paginated results do not affect read status. Read status is different to email opened event as it depends on your own account accessing the email. Email opened is determined by tracking pixels sent to other uses if enable during sending. You can listened for both email read and email opened events using webhooks.
Return values
self —setRecipients()
Sets recipients
public
setRecipients(EmailRecipients|null $recipients) : self
Parameters
- $recipients : EmailRecipients|null
-
recipients
Return values
self —setReplyTo()
Sets reply_to
public
setReplyTo(string|null $reply_to) : self
Parameters
- $reply_to : string|null
-
The
replyTo
field on the received email message
Return values
self —setSender()
Sets sender
public
setSender(Sender|null $sender) : self
Parameters
- $sender : Sender|null
-
sender
Return values
self —setSubject()
Sets subject
public
setSubject(string|null $subject) : self
Parameters
- $subject : string|null
-
The subject line of the email message as specified by SMTP subject header
Return values
self —setTeamAccess()
Sets team_access
public
setTeamAccess(bool $team_access) : self
Parameters
- $team_access : bool
-
Can the email be accessed by organization team members
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> —setTextExcerpt()
Sets text_excerpt
public
setTextExcerpt(string|null $text_excerpt) : self
Parameters
- $text_excerpt : string|null
-
An excerpt of the body of the email message for quick preview. Takes TEXT content part if exists
Return values
self —setTo()
Sets to
public
setTo(array<string|int, string> $to) : self
Parameters
- $to : array<string|int, string>
-
List of
To
recipient email addresses that the email was addressed to. See recipients object for names.
Return values
self —setUpdatedAt()
Sets updated_at
public
setUpdatedAt(DateTime $updated_at) : self
Parameters
- $updated_at : DateTime
-
When was the email last updated
Return values
self —setUserId()
Sets user_id
public
setUserId(string $user_id) : self
Parameters
- $user_id : string
-
ID of user that email belongs to
Return values
self —setXampHtml()
Sets xamp_html
public
setXampHtml(bool|null $xamp_html) : self
Parameters
- $xamp_html : bool|null
-
xamp_html
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>