Documentation

EmailThreadProjection
in package
implements ModelInterface, ArrayAccess, JsonSerializable

EmailThreadProjection Class Doc Comment

Tags
category

Class

description

An email thread is a message thread created for a email based on Message-ID, In-Reply-To, and References headers

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

\ArrayAccess<string, mixed>

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
getBcc()  : array<string|int, string>|null
Gets bcc
getCc()  : array<string|int, string>|null
Gets cc
getCreatedAt()  : DateTime
Gets created_at
getFrom()  : string|null
Gets from
getHasAttachments()  : bool
Gets has_attachments
getId()  : string
Gets id
getInboxId()  : string|null
Gets inbox_id
getLastBodyExcerpt()  : string|null
Gets last_body_excerpt
getLastCreatedAt()  : DateTime|null
Gets last_created_at
getLastFrom()  : string|null
Gets last_from
getLastSender()  : SenderProjection|null
Gets last_sender
getLastTextExcerpt()  : string|null
Gets last_text_excerpt
getMessageCount()  : int
Gets message_count
getModelName()  : string
The original name of the model.
getRecipients()  : EmailRecipientsProjection|null
Gets recipients
getSender()  : SenderProjection|null
Gets sender
getSubject()  : string|null
Gets subject
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTo()  : array<string|int, string>
Gets to
getUnread()  : bool
Gets unread
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
setBcc()  : self
Sets bcc
setCc()  : self
Sets cc
setCreatedAt()  : self
Sets created_at
setFrom()  : self
Sets from
setHasAttachments()  : self
Sets has_attachments
setId()  : self
Sets id
setInboxId()  : self
Sets inbox_id
setLastBodyExcerpt()  : self
Sets last_body_excerpt
setLastCreatedAt()  : self
Sets last_created_at
setLastFrom()  : self
Sets last_from
setLastSender()  : self
Sets last_sender
setLastTextExcerpt()  : self
Sets last_text_excerpt
setMessageCount()  : self
Sets message_count
setRecipients()  : self
Sets recipients
setSender()  : self
Sets sender
setSubject()  : self
Sets subject
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTo()  : self
Sets to
setUnread()  : self
Sets unread
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

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 = ['subject' => 'subject', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt', 'unread' => 'unread', 'sender' => 'sender', 'recipients' => 'recipients', 'user_id' => 'userId', 'inbox_id' => 'inboxId', 'to' => 'to', 'cc' => 'cc', 'bcc' => 'bcc', 'has_attachments' => 'hasAttachments', 'message_count' => 'messageCount', 'last_body_excerpt' => 'lastBodyExcerpt', 'last_text_excerpt' => 'lastTextExcerpt', 'last_created_at' => 'lastCreatedAt', 'last_from' => 'lastFrom', 'last_sender' => 'lastSender', 'id' => 'id', 'from' => 'from']

$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 = ['subject' => 'getSubject', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt', 'unread' => 'getUnread', 'sender' => 'getSender', 'recipients' => 'getRecipients', 'user_id' => 'getUserId', 'inbox_id' => 'getInboxId', 'to' => 'getTo', 'cc' => 'getCc', 'bcc' => 'getBcc', 'has_attachments' => 'getHasAttachments', 'message_count' => 'getMessageCount', 'last_body_excerpt' => 'getLastBodyExcerpt', 'last_text_excerpt' => 'getLastTextExcerpt', 'last_created_at' => 'getLastCreatedAt', 'last_from' => 'getLastFrom', 'last_sender' => 'getLastSender', 'id' => 'getId', 'from' => 'getFrom']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $openAPIFormats = ['subject' => null, 'created_at' => 'date-time', 'updated_at' => 'date-time', 'unread' => null, 'sender' => null, 'recipients' => null, 'user_id' => 'uuid', 'inbox_id' => 'uuid', 'to' => null, 'cc' => null, 'bcc' => null, 'has_attachments' => null, 'message_count' => 'int32', 'last_body_excerpt' => null, 'last_text_excerpt' => null, 'last_created_at' => 'date-time', 'last_from' => null, 'last_sender' => null, 'id' => 'uuid', 'from' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'EmailThreadProjection'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['subject' => false, 'created_at' => false, 'updated_at' => false, 'unread' => false, 'sender' => false, 'recipients' => false, 'user_id' => false, 'inbox_id' => false, 'to' => false, 'cc' => false, 'bcc' => false, 'has_attachments' => false, 'message_count' => false, 'last_body_excerpt' => false, 'last_text_excerpt' => false, 'last_created_at' => false, 'last_from' => false, 'last_sender' => false, 'id' => false, 'from' => 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 = ['subject' => 'string', 'created_at' => '\\DateTime', 'updated_at' => '\\DateTime', 'unread' => 'bool', 'sender' => '\\MailSlurp\\Models\\SenderProjection', 'recipients' => '\\MailSlurp\\Models\\EmailRecipientsProjection', 'user_id' => 'string', 'inbox_id' => 'string', 'to' => 'string[]', 'cc' => 'string[]', 'bcc' => 'string[]', 'has_attachments' => 'bool', 'message_count' => 'int', 'last_body_excerpt' => 'string', 'last_text_excerpt' => 'string', 'last_created_at' => '\\DateTime', 'last_from' => 'string', 'last_sender' => '\\MailSlurp\\Models\\SenderProjection', 'id' => 'string', 'from' => 'string']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['subject' => 'setSubject', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt', 'unread' => 'setUnread', 'sender' => 'setSender', 'recipients' => 'setRecipients', 'user_id' => 'setUserId', 'inbox_id' => 'setInboxId', 'to' => 'setTo', 'cc' => 'setCc', 'bcc' => 'setBcc', 'has_attachments' => 'setHasAttachments', 'message_count' => 'setMessageCount', 'last_body_excerpt' => 'setLastBodyExcerpt', 'last_text_excerpt' => 'setLastTextExcerpt', 'last_created_at' => 'setLastCreatedAt', 'last_from' => 'setLastFrom', 'last_sender' => 'setLastSender', 'id' => 'setId', 'from' => 'setFrom']

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> —

getBcc()

Gets bcc

public getBcc() : 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 —

getHasAttachments()

Gets has_attachments

public getHasAttachments() : bool
Return values
bool —

getLastBodyExcerpt()

Gets last_body_excerpt

public getLastBodyExcerpt() : string|null
Return values
string|null —

getLastCreatedAt()

Gets last_created_at

public getLastCreatedAt() : DateTime|null
Return values
DateTime|null —

getLastFrom()

Gets last_from

public getLastFrom() : string|null
Return values
string|null —

getLastTextExcerpt()

Gets last_text_excerpt

public getLastTextExcerpt() : string|null
Return values
string|null —

getModelName()

The original name of the model.

public getModelName() : string
Return values
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> —

getTo()

Gets to

public getTo() : 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 —

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> —

setBcc()

Sets bcc

public setBcc(array<string|int, string>|null $bcc) : self
Parameters
$bcc : array<string|int, string>|null

BCC recipients

Return values
self —

setCc()

Sets cc

public setCc(array<string|int, string>|null $cc) : self
Parameters
$cc : array<string|int, string>|null

CC recipients

Return values
self —

setCreatedAt()

Sets created_at

public setCreatedAt(DateTime $created_at) : self
Parameters
$created_at : DateTime

Created at DateTime

Return values
self —

setFrom()

Sets from

public setFrom(string|null $from) : self
Parameters
$from : string|null

From sender

Return values
self —

setHasAttachments()

Sets has_attachments

public setHasAttachments(bool $has_attachments) : self
Parameters
$has_attachments : bool

Has attachments

Return values
self —

setId()

Sets id

public setId(string $id) : self
Parameters
$id : string

ID of email thread

Return values
self —

setInboxId()

Sets inbox_id

public setInboxId(string|null $inbox_id) : self
Parameters
$inbox_id : string|null

Inbox ID

Return values
self —

setLastBodyExcerpt()

Sets last_body_excerpt

public setLastBodyExcerpt(string|null $last_body_excerpt) : self
Parameters
$last_body_excerpt : string|null

Last body excerpt

Return values
self —

setLastCreatedAt()

Sets last_created_at

public setLastCreatedAt(DateTime|null $last_created_at) : self
Parameters
$last_created_at : DateTime|null

Last email created time

Return values
self —

setLastFrom()

Sets last_from

public setLastFrom(string|null $last_from) : self
Parameters
$last_from : string|null

Last sender

Return values
self —

setLastTextExcerpt()

Sets last_text_excerpt

public setLastTextExcerpt(string|null $last_text_excerpt) : self
Parameters
$last_text_excerpt : string|null

Last text excerpt

Return values
self —

setMessageCount()

Sets message_count

public setMessageCount(int $message_count) : self
Parameters
$message_count : int

Number of messages in the thread

Return values
self —

setSubject()

Sets subject

public setSubject(string|null $subject) : self
Parameters
$subject : string|null

Thread topic 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> —

setTo()

Sets to

public setTo(array<string|int, string> $to) : self
Parameters
$to : array<string|int, string>

To recipients

Return values
self —

setUnread()

Sets unread

public setUnread(bool $unread) : self
Parameters
$unread : bool

Has unread

Return values
self —

setUpdatedAt()

Sets updated_at

public setUpdatedAt(DateTime $updated_at) : self
Parameters
$updated_at : DateTime

Updated at DateTime

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>
Return values
void —

Search results