SentEmailDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
SentEmailDto 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
- getAttachments() : array<string|int, string>|null
- Gets attachments
- getBcc() : array<string|int, string>|null
- Gets bcc
- getBody() : string|null
- Gets body
- getBodyMd5Hash() : string|null
- Gets body_md5_hash
- getCc() : array<string|int, string>|null
- Gets cc
- getCharset() : string|null
- Gets charset
- getDomainId() : string|null
- Gets domain_id
- getFrom() : string|null
- Gets from
- getHeaders() : array<string, string>|null
- Gets headers
- getHtml() : bool|null
- Gets html
- getId() : string
- Gets id
- getInboxId() : string
- Gets inbox_id
- getIsHtml() : bool|null
- Gets is_html
- getMessageId() : string|null
- Gets message_id
- getMessageIds() : array<string|int, string>|null
- Gets message_ids
- getModelName() : string
- The original name of the model.
- getPixelIds() : array<string|int, string>|null
- Gets pixel_ids
- getReplyTo() : string|null
- Gets reply_to
- getSentAt() : DateTime
- Gets sent_at
- getSubject() : string|null
- Gets subject
- getTemplateId() : string|null
- Gets template_id
- getTemplateVariables() : array<string, object>|null
- Gets template_variables
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTo() : array<string|int, string>|null
- Gets to
- getToContacts() : array<string|int, string>|null
- Gets to_contacts
- getToGroup() : string|null
- Gets to_group
- getUserId() : string
- Gets user_id
- getVirtualSend() : bool|null
- Gets virtual_send
- 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
- setAttachments() : self
- Sets attachments
- setBcc() : self
- Sets bcc
- setBody() : self
- Sets body
- setBodyMd5Hash() : self
- Sets body_md5_hash
- setCc() : self
- Sets cc
- setCharset() : self
- Sets charset
- setDomainId() : self
- Sets domain_id
- setFrom() : self
- Sets from
- setHeaders() : self
- Sets headers
- setHtml() : self
- Sets html
- setId() : self
- Sets id
- setInboxId() : self
- Sets inbox_id
- setIsHtml() : self
- Sets is_html
- setMessageId() : self
- Sets message_id
- setMessageIds() : self
- Sets message_ids
- setPixelIds() : self
- Sets pixel_ids
- setReplyTo() : self
- Sets reply_to
- setSentAt() : self
- Sets sent_at
- setSubject() : self
- Sets subject
- setTemplateId() : self
- Sets template_id
- setTemplateVariables() : self
- Sets template_variables
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTo() : self
- Sets to
- setToContacts() : self
- Sets to_contacts
- setToGroup() : self
- Sets to_group
- setUserId() : self
- Sets user_id
- setVirtualSend() : self
- Sets virtual_send
- 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', 'reply_to' => 'replyTo', 'cc' => 'cc', 'bcc' => 'bcc', 'attachments' => 'attachments', 'subject' => 'subject', 'body_md5_hash' => 'bodyMD5Hash', 'body' => 'body', 'to_contacts' => 'toContacts', 'to_group' => 'toGroup', 'charset' => 'charset', 'is_html' => 'isHTML', 'sent_at' => 'sentAt', 'pixel_ids' => 'pixelIds', 'message_id' => 'messageId', 'message_ids' => 'messageIds', 'virtual_send' => 'virtualSend', 'template_id' => 'templateId', 'template_variables' => 'templateVariables', 'headers' => 'headers', 'html' => 'html']
$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', 'reply_to' => 'getReplyTo', 'cc' => 'getCc', 'bcc' => 'getBcc', 'attachments' => 'getAttachments', 'subject' => 'getSubject', 'body_md5_hash' => 'getBodyMd5Hash', 'body' => 'getBody', 'to_contacts' => 'getToContacts', 'to_group' => 'getToGroup', 'charset' => 'getCharset', 'is_html' => 'getIsHtml', 'sent_at' => 'getSentAt', 'pixel_ids' => 'getPixelIds', 'message_id' => 'getMessageId', 'message_ids' => 'getMessageIds', 'virtual_send' => 'getVirtualSend', 'template_id' => 'getTemplateId', 'template_variables' => 'getTemplateVariables', 'headers' => 'getHeaders', 'html' => 'getHtml']
$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, 'reply_to' => null, 'cc' => null, 'bcc' => null, 'attachments' => null, 'subject' => null, 'body_md5_hash' => null, 'body' => null, 'to_contacts' => 'uuid', 'to_group' => 'uuid', 'charset' => null, 'is_html' => null, 'sent_at' => 'date-time', 'pixel_ids' => 'uuid', 'message_id' => null, 'message_ids' => null, 'virtual_send' => null, 'template_id' => 'uuid', 'template_variables' => null, 'headers' => null, 'html' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'SentEmailDto'
$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' => true, 'from' => true, 'reply_to' => true, 'cc' => true, 'bcc' => true, 'attachments' => true, 'subject' => true, 'body_md5_hash' => true, 'body' => true, 'to_contacts' => true, 'to_group' => true, 'charset' => true, 'is_html' => true, 'sent_at' => false, 'pixel_ids' => true, 'message_id' => true, 'message_ids' => true, 'virtual_send' => true, 'template_id' => true, 'template_variables' => true, 'headers' => true, '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', 'reply_to' => 'string', 'cc' => 'string[]', 'bcc' => 'string[]', 'attachments' => 'string[]', 'subject' => 'string', 'body_md5_hash' => 'string', 'body' => 'string', 'to_contacts' => 'string[]', 'to_group' => 'string', 'charset' => 'string', 'is_html' => 'bool', 'sent_at' => '\\DateTime', 'pixel_ids' => 'string[]', 'message_id' => 'string', 'message_ids' => 'string[]', 'virtual_send' => 'bool', 'template_id' => 'string', 'template_variables' => 'array<string,object>', 'headers' => 'array<string,string>', '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', 'reply_to' => 'setReplyTo', 'cc' => 'setCc', 'bcc' => 'setBcc', 'attachments' => 'setAttachments', 'subject' => 'setSubject', 'body_md5_hash' => 'setBodyMd5Hash', 'body' => 'setBody', 'to_contacts' => 'setToContacts', 'to_group' => 'setToGroup', 'charset' => 'setCharset', 'is_html' => 'setIsHtml', 'sent_at' => 'setSentAt', 'pixel_ids' => 'setPixelIds', 'message_id' => 'setMessageId', 'message_ids' => 'setMessageIds', 'virtual_send' => 'setVirtualSend', 'template_id' => 'setTemplateId', 'template_variables' => 'setTemplateVariables', 'headers' => 'setHeaders', 'html' => 'setHtml']
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> —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 —getBodyMd5Hash()
Gets body_md5_hash
public
getBodyMd5Hash() : string|null
Return values
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 —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
Return values
array<string, 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 —getMessageId()
Gets message_id
public
getMessageId() : string|null
Return values
string|null —getMessageIds()
Gets message_ids
public
getMessageIds() : 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 —getPixelIds()
Gets pixel_ids
public
getPixelIds() : array<string|int, string>|null
Return values
array<string|int, string>|null —getReplyTo()
Gets reply_to
public
getReplyTo() : string|null
Return values
string|null —getSentAt()
Gets sent_at
public
getSentAt() : DateTime
Return values
DateTime —getSubject()
Gets subject
public
getSubject() : string|null
Return values
string|null —getTemplateId()
Gets template_id
public
getTemplateId() : string|null
Return values
string|null —getTemplateVariables()
Gets template_variables
public
getTemplateVariables() : array<string, object>|null
Return values
array<string, object>|null —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTo()
Gets to
public
getTo() : array<string|int, string>|null
Return values
array<string|int, string>|null —getToContacts()
Gets to_contacts
public
getToContacts() : array<string|int, string>|null
Return values
array<string|int, string>|null —getToGroup()
Gets to_group
public
getToGroup() : string|null
Return values
string|null —getUserId()
Gets user_id
public
getUserId() : string
Return values
string —getVirtualSend()
Gets virtual_send
public
getVirtualSend() : 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> —setAttachments()
Sets attachments
public
setAttachments(array<string|int, string>|null $attachments) : self
Parameters
- $attachments : array<string|int, string>|null
-
Array of IDs of attachments that were sent with this email
Return values
self —setBcc()
Sets bcc
public
setBcc(array<string|int, string>|null $bcc) : self
Parameters
- $bcc : array<string|int, string>|null
-
bcc
Return values
self —setBody()
Sets body
public
setBody(string|null $body) : self
Parameters
- $body : string|null
-
Sent email body
Return values
self —setBodyMd5Hash()
Sets body_md5_hash
public
setBodyMd5Hash(string|null $body_md5_hash) : self
Parameters
- $body_md5_hash : string|null
-
MD5 Hash
Return values
self —setCc()
Sets cc
public
setCc(array<string|int, string>|null $cc) : self
Parameters
- $cc : array<string|int, string>|null
-
cc
Return values
self —setCharset()
Sets charset
public
setCharset(string|null $charset) : self
Parameters
- $charset : string|null
-
charset
Return values
self —setDomainId()
Sets domain_id
public
setDomainId(string|null $domain_id) : self
Parameters
- $domain_id : string|null
-
Domain ID
Return values
self —setFrom()
Sets from
public
setFrom(string|null $from) : self
Parameters
- $from : string|null
-
Sent from address
Return values
self —setHeaders()
Sets headers
public
setHeaders(array<string, string>|null $headers) : self
Parameters
- $headers : array<string, string>|null
-
headers
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 sent email
Return values
self —setInboxId()
Sets inbox_id
public
setInboxId(string $inbox_id) : self
Parameters
- $inbox_id : string
-
Inbox ID email was sent from
Return values
self —setIsHtml()
Sets is_html
public
setIsHtml(bool|null $is_html) : self
Parameters
- $is_html : bool|null
-
is_html
Return values
self —setMessageId()
Sets message_id
public
setMessageId(string|null $message_id) : self
Parameters
- $message_id : string|null
-
message_id
Return values
self —setMessageIds()
Sets message_ids
public
setMessageIds(array<string|int, string>|null $message_ids) : self
Parameters
- $message_ids : array<string|int, string>|null
-
message_ids
Return values
self —setPixelIds()
Sets pixel_ids
public
setPixelIds(array<string|int, string>|null $pixel_ids) : self
Parameters
- $pixel_ids : array<string|int, string>|null
-
pixel_ids
Return values
self —setReplyTo()
Sets reply_to
public
setReplyTo(string|null $reply_to) : self
Parameters
- $reply_to : string|null
-
reply_to
Return values
self —setSentAt()
Sets sent_at
public
setSentAt(DateTime $sent_at) : self
Parameters
- $sent_at : DateTime
-
sent_at
Return values
self —setSubject()
Sets subject
public
setSubject(string|null $subject) : self
Parameters
- $subject : string|null
-
subject
Return values
self —setTemplateId()
Sets template_id
public
setTemplateId(string|null $template_id) : self
Parameters
- $template_id : string|null
-
template_id
Return values
self —setTemplateVariables()
Sets template_variables
public
setTemplateVariables(array<string, object>|null $template_variables) : self
Parameters
- $template_variables : array<string, object>|null
-
template_variables
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> —setTo()
Sets to
public
setTo(array<string|int, string>|null $to) : self
Parameters
- $to : array<string|int, string>|null
-
Recipients email was sent to
Return values
self —setToContacts()
Sets to_contacts
public
setToContacts(array<string|int, string>|null $to_contacts) : self
Parameters
- $to_contacts : array<string|int, string>|null
-
to_contacts
Return values
self —setToGroup()
Sets to_group
public
setToGroup(string|null $to_group) : self
Parameters
- $to_group : string|null
-
to_group
Return values
self —setUserId()
Sets user_id
public
setUserId(string $user_id) : self
Parameters
- $user_id : string
-
User ID
Return values
self —setVirtualSend()
Sets virtual_send
public
setVirtualSend(bool|null $virtual_send) : self
Parameters
- $virtual_send : bool|null
-
virtual_send
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>