EmailDraftDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
EmailDraftDto 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
- getBodyExcerpt() : string|null
- Gets body_excerpt
- getCc() : array<string|int, string>|null
- Gets cc
- getCreatedAt() : DateTime
- Gets created_at
- getFrom() : string|null
- Gets from
- getId() : string
- Gets id
- getInboxId() : string
- Gets inbox_id
- getModelName() : string
- The original name of the model.
- getRecipients() : SentEmailDtoRecipients|null
- Gets recipients
- getSender() : SentEmailDtoSender|null
- Gets sender
- getSendOptions() : SendEmailOptions
- Gets send_options
- getSubject() : string|null
- Gets subject
- 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>|null
- Gets to
- getUpdatedAt() : DateTime
- Gets updated_at
- getUserId() : string
- Gets user_id
- 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
- setBodyExcerpt() : self
- Sets body_excerpt
- setCc() : self
- Sets cc
- setCreatedAt() : self
- Sets created_at
- setFrom() : self
- Sets from
- setId() : self
- Sets id
- setInboxId() : self
- Sets inbox_id
- setRecipients() : self
- Sets recipients
- setSender() : self
- Sets sender
- setSendOptions() : self
- Sets send_options
- setSubject() : self
- Sets subject
- 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
- 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', 'to' => 'to', 'cc' => 'cc', 'bcc' => 'bcc', 'from' => 'from', 'sender' => 'sender', 'recipients' => 'recipients', 'subject' => 'subject', 'body_excerpt' => 'bodyExcerpt', 'text_excerpt' => 'textExcerpt', 'attachments' => 'attachments', 'send_options' => 'sendOptions', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt']
$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', 'to' => 'getTo', 'cc' => 'getCc', 'bcc' => 'getBcc', 'from' => 'getFrom', 'sender' => 'getSender', 'recipients' => 'getRecipients', 'subject' => 'getSubject', 'body_excerpt' => 'getBodyExcerpt', 'text_excerpt' => 'getTextExcerpt', 'attachments' => 'getAttachments', 'send_options' => 'getSendOptions', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt']
$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', 'to' => null, 'cc' => null, 'bcc' => null, 'from' => null, 'sender' => null, 'recipients' => null, 'subject' => null, 'body_excerpt' => null, 'text_excerpt' => null, 'attachments' => null, 'send_options' => null, 'created_at' => 'date-time', 'updated_at' => 'date-time']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'EmailDraftDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'user_id' => false, 'inbox_id' => false, 'to' => true, 'cc' => true, 'bcc' => true, 'from' => true, 'sender' => true, 'recipients' => true, 'subject' => true, 'body_excerpt' => true, 'text_excerpt' => true, 'attachments' => true, 'send_options' => false, 'created_at' => false, 'updated_at' => 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', 'to' => 'string[]', 'cc' => 'string[]', 'bcc' => 'string[]', 'from' => 'string', 'sender' => '\\MailSlurp\\Models\\SentEmailDtoSender', 'recipients' => '\\MailSlurp\\Models\\SentEmailDtoRecipients', 'subject' => 'string', 'body_excerpt' => 'string', 'text_excerpt' => 'string', 'attachments' => 'string[]', 'send_options' => '\\MailSlurp\\Models\\SendEmailOptions', 'created_at' => '\\DateTime', 'updated_at' => '\\DateTime']
$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', 'to' => 'setTo', 'cc' => 'setCc', 'bcc' => 'setBcc', 'from' => 'setFrom', 'sender' => 'setSender', 'recipients' => 'setRecipients', 'subject' => 'setSubject', 'body_excerpt' => 'setBodyExcerpt', 'text_excerpt' => 'setTextExcerpt', 'attachments' => 'setAttachments', 'send_options' => 'setSendOptions', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt']
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 —getBodyExcerpt()
Gets body_excerpt
public
getBodyExcerpt() : string|null
Return values
string|null —getCc()
Gets cc
public
getCc() : array<string|int, string>|null
Return values
array<string|int, string>|null —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —getFrom()
Gets from
public
getFrom() : string|null
Return values
string|null —getId()
Gets id
public
getId() : string
Return values
string —getInboxId()
Gets inbox_id
public
getInboxId() : string
Return values
string —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getRecipients()
Gets recipients
public
getRecipients() : SentEmailDtoRecipients|null
Return values
SentEmailDtoRecipients|null —getSender()
Gets sender
public
getSender() : SentEmailDtoSender|null
Return values
SentEmailDtoSender|null —getSendOptions()
Gets send_options
public
getSendOptions() : SendEmailOptions
Return values
SendEmailOptions —getSubject()
Gets subject
public
getSubject() : string|null
Return values
string|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> —getTextExcerpt()
Gets text_excerpt
public
getTextExcerpt() : string|null
Return values
string|null —getTo()
Gets to
public
getTo() : array<string|int, string>|null
Return values
array<string|int, string>|null —getUpdatedAt()
Gets updated_at
public
getUpdatedAt() : DateTime
Return values
DateTime —getUserId()
Gets user_id
public
getUserId() : string
Return values
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> —setAttachments()
Sets attachments
public
setAttachments(array<string|int, string>|null $attachments) : self
Parameters
- $attachments : array<string|int, string>|null
-
Attachment IDs selected for the draft
Return values
self —setBcc()
Sets bcc
public
setBcc(array<string|int, string>|null $bcc) : self
Parameters
- $bcc : array<string|int, string>|null
-
Draft BCC recipients
Return values
self —setBodyExcerpt()
Sets body_excerpt
public
setBodyExcerpt(string|null $body_excerpt) : self
Parameters
- $body_excerpt : string|null
-
Draft body preview
Return values
self —setCc()
Sets cc
public
setCc(array<string|int, string>|null $cc) : self
Parameters
- $cc : array<string|int, string>|null
-
Draft CC recipients
Return values
self —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
Draft creation time
Return values
self —setFrom()
Sets from
public
setFrom(string|null $from) : self
Parameters
- $from : string|null
-
Draft sender
Return values
self —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
ID of the draft
Return values
self —setInboxId()
Sets inbox_id
public
setInboxId(string $inbox_id) : self
Parameters
- $inbox_id : string
-
Inbox ID the draft will send from
Return values
self —setRecipients()
Sets recipients
public
setRecipients(SentEmailDtoRecipients|null $recipients) : self
Parameters
- $recipients : SentEmailDtoRecipients|null
-
recipients
Return values
self —setSender()
Sets sender
public
setSender(SentEmailDtoSender|null $sender) : self
Parameters
- $sender : SentEmailDtoSender|null
-
sender
Return values
self —setSendOptions()
Sets send_options
public
setSendOptions(SendEmailOptions $send_options) : self
Parameters
- $send_options : SendEmailOptions
-
send_options
Return values
self —setSubject()
Sets subject
public
setSubject(string|null $subject) : self
Parameters
- $subject : string|null
-
Draft subject
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
-
Draft text preview
Return values
self —setTo()
Sets to
public
setTo(array<string|int, string>|null $to) : self
Parameters
- $to : array<string|int, string>|null
-
Draft recipients
Return values
self —setUpdatedAt()
Sets updated_at
public
setUpdatedAt(DateTime $updated_at) : self
Parameters
- $updated_at : DateTime
-
Draft last update time
Return values
self —setUserId()
Sets user_id
public
setUserId(string $user_id) : self
Parameters
- $user_id : string
-
User ID
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>