Documentation

InboxPreview
in package
implements ModelInterface, ArrayAccess, JsonSerializable

InboxPreview Class Doc Comment

Tags
category

Class

description

Inbox data preview element.

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
FUNCTIONS_AS_ALIAS  = 'ALIAS'
FUNCTIONS_AS_CATCH_ALL  = 'CATCH_ALL'
FUNCTIONS_AS_CONNECTOR  = 'CONNECTOR'
FUNCTIONS_AS_THREAD  = 'THREAD'
INBOX_TYPE_HTTP_INBOX  = 'HTTP_INBOX'
INBOX_TYPE_SMTP_INBOX  = 'SMTP_INBOX'
$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
getCreatedAt()  : DateTime
Gets created_at
getDomainId()  : string|null
Gets domain_id
getEmailAddress()  : string|null
Gets email_address
getExpiresAt()  : string|null
Gets expires_at
getFavourite()  : bool
Gets favourite
getFunctionsAs()  : string|null
Gets functions_as
getFunctionsAsAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getId()  : string
Gets id
getInboxType()  : string|null
Gets inbox_type
getInboxTypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getTags()  : array<string|int, string>|null
Gets tags
getTeamAccess()  : bool
Gets team_access
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getVirtualInbox()  : bool
Gets virtual_inbox
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
setCreatedAt()  : self
Sets created_at
setDomainId()  : self
Sets domain_id
setEmailAddress()  : self
Sets email_address
setExpiresAt()  : self
Sets expires_at
setFavourite()  : self
Sets favourite
setFunctionsAs()  : self
Sets functions_as
setId()  : self
Sets id
setInboxType()  : self
Sets inbox_type
setName()  : self
Sets name
setTags()  : self
Sets tags
setTeamAccess()  : self
Sets team_access
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setVirtualInbox()  : self
Sets virtual_inbox
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

FUNCTIONS_AS_ALIAS

public mixed FUNCTIONS_AS_ALIAS = 'ALIAS'

FUNCTIONS_AS_CATCH_ALL

public mixed FUNCTIONS_AS_CATCH_ALL = 'CATCH_ALL'

FUNCTIONS_AS_CONNECTOR

public mixed FUNCTIONS_AS_CONNECTOR = 'CONNECTOR'

FUNCTIONS_AS_THREAD

public mixed FUNCTIONS_AS_THREAD = 'THREAD'

INBOX_TYPE_HTTP_INBOX

public mixed INBOX_TYPE_HTTP_INBOX = 'HTTP_INBOX'

INBOX_TYPE_SMTP_INBOX

public mixed INBOX_TYPE_SMTP_INBOX = 'SMTP_INBOX'

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', 'email_address' => 'emailAddress', 'created_at' => 'createdAt', 'favourite' => 'favourite', 'name' => 'name', 'tags' => 'tags', 'team_access' => 'teamAccess', 'inbox_type' => 'inboxType', 'virtual_inbox' => 'virtualInbox', 'expires_at' => 'expiresAt', 'functions_as' => 'functionsAs']

$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', 'email_address' => 'getEmailAddress', 'created_at' => 'getCreatedAt', 'favourite' => 'getFavourite', 'name' => 'getName', 'tags' => 'getTags', 'team_access' => 'getTeamAccess', 'inbox_type' => 'getInboxType', 'virtual_inbox' => 'getVirtualInbox', 'expires_at' => 'getExpiresAt', 'functions_as' => 'getFunctionsAs']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['id' => 'uuid', 'domain_id' => 'uuid', 'email_address' => null, 'created_at' => 'date-time', 'favourite' => null, 'name' => null, 'tags' => null, 'team_access' => null, 'inbox_type' => null, 'virtual_inbox' => null, 'expires_at' => null, 'functions_as' => 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 = 'InboxPreview'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['id' => false, 'domain_id' => true, 'email_address' => true, 'created_at' => false, 'favourite' => false, 'name' => true, 'tags' => true, 'team_access' => false, 'inbox_type' => true, 'virtual_inbox' => false, 'expires_at' => true, 'functions_as' => 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', 'email_address' => 'string', 'created_at' => '\\DateTime', 'favourite' => 'bool', 'name' => 'string', 'tags' => 'string[]', 'team_access' => 'bool', 'inbox_type' => 'string', 'virtual_inbox' => 'bool', 'expires_at' => 'string', 'functions_as' => 'string']

$setters

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

protected static array<string|int, string> $setters = ['id' => 'setId', 'domain_id' => 'setDomainId', 'email_address' => 'setEmailAddress', 'created_at' => 'setCreatedAt', 'favourite' => 'setFavourite', 'name' => 'setName', 'tags' => 'setTags', 'team_access' => 'setTeamAccess', 'inbox_type' => 'setInboxType', 'virtual_inbox' => 'setVirtualInbox', 'expires_at' => 'setExpiresAt', 'functions_as' => 'setFunctionsAs']

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

getCreatedAt()

Gets created_at

public getCreatedAt() : DateTime
Return values
DateTime —

getDomainId()

Gets domain_id

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

getEmailAddress()

Gets email_address

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

getExpiresAt()

Gets expires_at

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

getFavourite()

Gets favourite

public getFavourite() : bool
Return values
bool —

getFunctionsAs()

Gets functions_as

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

getFunctionsAsAllowableValues()

Gets allowable values of the enum

public getFunctionsAsAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getId()

Gets id

public getId() : string
Return values
string —

getInboxType()

Gets inbox_type

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

getInboxTypeAllowableValues()

Gets allowable values of the enum

public getInboxTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getName()

Gets name

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

getTags()

Gets tags

public getTags() : array<string|int, string>|null
Return values
array<string|int, 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> —

getVirtualInbox()

Gets virtual_inbox

public getVirtualInbox() : bool
Return values
bool —

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

setCreatedAt()

Sets created_at

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

When the inbox was created. Time stamps are in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX e.g. 2000-10-31T01:30:00.000-05:00.

Return values
self —

setDomainId()

Sets domain_id

public setDomainId(string|null $domain_id) : self
Parameters
$domain_id : string|null

ID of custom domain used by the inbox if any

Return values
self —

setEmailAddress()

Sets email_address

public setEmailAddress(string|null $email_address) : self
Parameters
$email_address : string|null

The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so +123 additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.

Return values
self —

setExpiresAt()

Sets expires_at

public setExpiresAt(string|null $expires_at) : self
Parameters
$expires_at : string|null

Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email.

Return values
self —

setFavourite()

Sets favourite

public setFavourite(bool $favourite) : self
Parameters
$favourite : bool

Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering

Return values
self —

setFunctionsAs()

Sets functions_as

public setFunctionsAs(string|null $functions_as) : self
Parameters
$functions_as : string|null

Inbox function if used as a primitive for another system.

Return values
self —

setId()

Sets id

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

ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods waitForLatestEmail and getEmails methods respectively. Inboxes can be used with aliases to forward emails automatically.

Return values
self —

setInboxType()

Sets inbox_type

public setInboxType(string|null $inbox_type) : self
Parameters
$inbox_type : string|null

Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).

Return values
self —

setName()

Sets name

public setName(string|null $name) : self
Parameters
$name : string|null

Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search

Return values
self —

setTags()

Sets tags

public setTags(array<string|int, string>|null $tags) : self
Parameters
$tags : array<string|int, string>|null

Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.

Return values
self —

setTeamAccess()

Sets team_access

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

Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at https://www.mailslurp.com/guides/team-email-account-sharing/

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

setVirtualInbox()

Sets virtual_inbox

public setVirtualInbox(bool $virtual_inbox) : self
Parameters
$virtual_inbox : bool

Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions.

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