Documentation

EmailProjection
in package
implements ModelInterface, ArrayAccess, JsonSerializable

EmailProjection Class Doc Comment

Tags
category

Class

description

A compact representation of a full email. Used in list endpoints to keep response sizes low. Body and attachments are not included. To get all fields of the email use the `getEmail` method with the email projection's ID. See `EmailDto` for documentation on projection properties.

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
getAttachments()  : array<string|int, string>|null
Gets attachments
getBcc()  : array<string|int, string>|null
Gets bcc
getBodyExcerpt()  : string|null
Gets body_excerpt
getBodyMd5Hash()  : string|null
Gets body_md5_hash
getCc()  : array<string|int, string>|null
Gets cc
getCreatedAt()  : DateTime
Gets created_at
getDomainId()  : string|null
Gets domain_id
getFrom()  : string|null
Gets from
getId()  : string
Gets id
getInboxId()  : string
Gets inbox_id
getModelName()  : string
The original name of the model.
getRead()  : bool
Gets read
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
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
setBodyMd5Hash()  : self
Sets body_md5_hash
setCc()  : self
Sets cc
setCreatedAt()  : self
Sets created_at
setDomainId()  : self
Sets domain_id
setFrom()  : self
Sets from
setId()  : self
Sets id
setInboxId()  : self
Sets inbox_id
setRead()  : self
Sets read
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
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 = ['created_at' => 'createdAt', 'attachments' => 'attachments', 'inbox_id' => 'inboxId', 'to' => 'to', 'domain_id' => 'domainId', 'bcc' => 'bcc', 'cc' => 'cc', 'read' => 'read', 'body_excerpt' => 'bodyExcerpt', 'team_access' => 'teamAccess', 'body_md5_hash' => 'bodyMD5Hash', 'text_excerpt' => 'textExcerpt', 'subject' => 'subject', '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 = ['created_at' => 'getCreatedAt', 'attachments' => 'getAttachments', 'inbox_id' => 'getInboxId', 'to' => 'getTo', 'domain_id' => 'getDomainId', 'bcc' => 'getBcc', 'cc' => 'getCc', 'read' => 'getRead', 'body_excerpt' => 'getBodyExcerpt', 'team_access' => 'getTeamAccess', 'body_md5_hash' => 'getBodyMd5Hash', 'text_excerpt' => 'getTextExcerpt', 'subject' => 'getSubject', 'id' => 'getId', 'from' => 'getFrom']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['created_at' => 'date-time', 'attachments' => null, 'inbox_id' => 'uuid', 'to' => null, 'domain_id' => 'uuid', 'bcc' => null, 'cc' => null, 'read' => null, 'body_excerpt' => null, 'team_access' => null, 'body_md5_hash' => null, 'text_excerpt' => null, 'subject' => 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 = 'EmailProjection'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['created_at' => false, 'attachments' => true, 'inbox_id' => false, 'to' => false, 'domain_id' => true, 'bcc' => true, 'cc' => true, 'read' => false, 'body_excerpt' => true, 'team_access' => false, 'body_md5_hash' => true, 'text_excerpt' => true, 'subject' => true, 'id' => false, 'from' => true]

$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 = ['created_at' => '\\DateTime', 'attachments' => 'string[]', 'inbox_id' => 'string', 'to' => 'string[]', 'domain_id' => 'string', 'bcc' => 'string[]', 'cc' => 'string[]', 'read' => 'bool', 'body_excerpt' => 'string', 'team_access' => 'bool', 'body_md5_hash' => 'string', 'text_excerpt' => 'string', 'subject' => 'string', 'id' => 'string', 'from' => 'string']

$setters

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

protected static array<string|int, string> $setters = ['created_at' => 'setCreatedAt', 'attachments' => 'setAttachments', 'inbox_id' => 'setInboxId', 'to' => 'setTo', 'domain_id' => 'setDomainId', 'bcc' => 'setBcc', 'cc' => 'setCc', 'read' => 'setRead', 'body_excerpt' => 'setBodyExcerpt', 'team_access' => 'setTeamAccess', 'body_md5_hash' => 'setBodyMd5Hash', 'text_excerpt' => 'setTextExcerpt', 'subject' => 'setSubject', '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> —

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 —

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 —

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 —

getInboxId()

Gets inbox_id

public getInboxId() : string
Return values
string —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

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

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

setAttachments()

Sets attachments

public setAttachments(array<string|int, string>|null $attachments) : self
Parameters
$attachments : array<string|int, string>|null

attachments

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 —

setBodyExcerpt()

Sets body_excerpt

public setBodyExcerpt(string|null $body_excerpt) : self
Parameters
$body_excerpt : string|null

body_excerpt

Return values
self —

setBodyMd5Hash()

Sets body_md5_hash

public setBodyMd5Hash(string|null $body_md5_hash) : self
Parameters
$body_md5_hash : string|null

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

setCreatedAt()

Sets created_at

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

created_at

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

from

Return values
self —

setId()

Sets id

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

id

Return values
self —

setInboxId()

Sets inbox_id

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

inbox_id

Return values
self —

setRead()

Sets read

public setRead(bool $read) : self
Parameters
$read : bool

read

Return values
self —

setSubject()

Sets subject

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

subject

Return values
self —

setTeamAccess()

Sets team_access

public setTeamAccess(bool $team_access) : self
Parameters
$team_access : bool

team_access

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

text_excerpt

Return values
self —

setTo()

Sets to

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

to

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