Documentation

EmailPreview
in package
implements ModelInterface, ArrayAccess, JsonSerializable

EmailPreview Class Doc Comment

Tags
category

Class

description

Preview of an email message. For full message (including body and attachments) call the `getEmail` or other email endpoints with the provided email ID.

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
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
getModelName()  : string
The original name of the model.
getRead()  : bool
Gets read
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
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
setCc()  : self
Sets cc
setCreatedAt()  : self
Sets created_at
setDomainId()  : self
Sets domain_id
setFrom()  : self
Sets from
setId()  : self
Sets id
setRead()  : self
Sets read
setSubject()  : self
Sets subject
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
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 = ['id' => 'id', 'domain_id' => 'domainId', 'subject' => 'subject', 'to' => 'to', 'from' => 'from', 'bcc' => 'bcc', 'cc' => 'cc', 'created_at' => 'createdAt', 'read' => 'read', 'attachments' => 'attachments']

$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', 'domain_id' => 'getDomainId', 'subject' => 'getSubject', 'to' => 'getTo', 'from' => 'getFrom', 'bcc' => 'getBcc', 'cc' => 'getCc', 'created_at' => 'getCreatedAt', 'read' => 'getRead', 'attachments' => 'getAttachments']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['id' => 'uuid', 'domain_id' => 'uuid', 'subject' => null, 'to' => null, 'from' => null, 'bcc' => null, 'cc' => null, 'created_at' => 'date-time', 'read' => null, 'attachments' => 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 = 'EmailPreview'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['id' => false, 'domain_id' => true, 'subject' => true, 'to' => true, 'from' => true, 'bcc' => true, 'cc' => true, 'created_at' => false, 'read' => false, 'attachments' => 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 = ['id' => 'string', 'domain_id' => 'string', 'subject' => 'string', 'to' => 'string[]', 'from' => 'string', 'bcc' => 'string[]', 'cc' => 'string[]', 'created_at' => '\\DateTime', 'read' => 'bool', 'attachments' => 'string[]']

$setters

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

protected static array<string|int, string> $setters = ['id' => 'setId', 'domain_id' => 'setDomainId', 'subject' => 'setSubject', 'to' => 'setTo', 'from' => 'setFrom', 'bcc' => 'setBcc', 'cc' => 'setCc', 'created_at' => 'setCreatedAt', 'read' => 'setRead', 'attachments' => 'setAttachments']

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 —

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 —

getId()

Gets id

public getId() : string
Return values
string —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getRead()

Gets read

public getRead() : bool
Return values
bool —

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

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

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 —

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 —

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 —

setId()

Sets id

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

ID of the email entity

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 —

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 —

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>

List of To recipient email addresses that the email was addressed to. See recipients object for names.

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