Documentation

InboxForwarderDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

InboxForwarderDto Class Doc Comment

Tags
category

Class

description

Inbox forwarder. Describes how an inbox will forward matching emails to designated recipients.

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

ATTACHMENT_TEXT_EXTRACTION_METHOD_AUTO  = 'AUTO'
ATTACHMENT_TEXT_EXTRACTION_METHOD_LLM  = 'LLM'
ATTACHMENT_TEXT_EXTRACTION_METHOD_NATIVE  = 'NATIVE'
ATTACHMENT_TEXT_EXTRACTION_METHOD_OCR  = 'OCR'
ATTACHMENT_TEXT_EXTRACTION_METHOD_OCR_THEN_LLM  = 'OCR_THEN_LLM'
DISCRIMINATOR  = null
FIELD_ATTACHMENT_FILENAME  = 'ATTACHMENT_FILENAME'
FIELD_ATTACHMENT_TEXT  = 'ATTACHMENT_TEXT'
FIELD_ATTACHMENTS  = 'ATTACHMENTS'
FIELD_RECIPIENTS  = 'RECIPIENTS'
FIELD_SENDER  = 'SENDER'
FIELD_SUBJECT  = 'SUBJECT'
SHOULD_CONTAIN  = 'CONTAIN'
SHOULD_EQUAL  = 'EQUAL'
SHOULD_MATCH  = 'MATCH'
SHOULD_WILDCARD  = 'WILDCARD'
$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
getAttachmentTextExtractionMethod()  : string|null
Gets attachment_text_extraction_method
getAttachmentTextExtractionMethodAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getCreatedAt()  : DateTime
Gets created_at
getField()  : string|null
Gets field
getFieldAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getForwardToRecipients()  : array<string|int, string>
Gets forward_to_recipients
getId()  : string
Gets id
getInboxId()  : string|null
Gets inbox_id
getMatch()  : string|null
Gets match
getMatchOptions()  : UpdateInboxReplierOptionsMatchOptions|null
Gets match_options
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getShould()  : string|null
Gets should
getShouldAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
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
setAttachmentTextExtractionMethod()  : self
Sets attachment_text_extraction_method
setCreatedAt()  : self
Sets created_at
setField()  : self
Sets field
setForwardToRecipients()  : self
Sets forward_to_recipients
setId()  : self
Sets id
setInboxId()  : self
Sets inbox_id
setMatch()  : self
Sets match
setMatchOptions()  : self
Sets match_options
setName()  : self
Sets name
setShould()  : self
Sets should
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
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

ATTACHMENT_TEXT_EXTRACTION_METHOD_AUTO

public mixed ATTACHMENT_TEXT_EXTRACTION_METHOD_AUTO = 'AUTO'

ATTACHMENT_TEXT_EXTRACTION_METHOD_LLM

public mixed ATTACHMENT_TEXT_EXTRACTION_METHOD_LLM = 'LLM'

ATTACHMENT_TEXT_EXTRACTION_METHOD_NATIVE

public mixed ATTACHMENT_TEXT_EXTRACTION_METHOD_NATIVE = 'NATIVE'

ATTACHMENT_TEXT_EXTRACTION_METHOD_OCR

public mixed ATTACHMENT_TEXT_EXTRACTION_METHOD_OCR = 'OCR'

ATTACHMENT_TEXT_EXTRACTION_METHOD_OCR_THEN_LLM

public mixed ATTACHMENT_TEXT_EXTRACTION_METHOD_OCR_THEN_LLM = 'OCR_THEN_LLM'

FIELD_ATTACHMENT_FILENAME

public mixed FIELD_ATTACHMENT_FILENAME = 'ATTACHMENT_FILENAME'

FIELD_ATTACHMENT_TEXT

public mixed FIELD_ATTACHMENT_TEXT = 'ATTACHMENT_TEXT'

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', 'inbox_id' => 'inboxId', 'name' => 'name', 'field' => 'field', 'match' => 'match', 'forward_to_recipients' => 'forwardToRecipients', 'created_at' => 'createdAt', 'should' => 'should', 'match_options' => 'matchOptions', 'attachment_text_extraction_method' => 'attachmentTextExtractionMethod']

$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', 'inbox_id' => 'getInboxId', 'name' => 'getName', 'field' => 'getField', 'match' => 'getMatch', 'forward_to_recipients' => 'getForwardToRecipients', 'created_at' => 'getCreatedAt', 'should' => 'getShould', 'match_options' => 'getMatchOptions', 'attachment_text_extraction_method' => 'getAttachmentTextExtractionMethod']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['id' => 'uuid', 'inbox_id' => 'uuid', 'name' => null, 'field' => null, 'match' => null, 'forward_to_recipients' => null, 'created_at' => 'date-time', 'should' => null, 'match_options' => null, 'attachment_text_extraction_method' => 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 = 'InboxForwarderDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['id' => false, 'inbox_id' => true, 'name' => true, 'field' => true, 'match' => true, 'forward_to_recipients' => false, 'created_at' => false, 'should' => true, 'match_options' => true, 'attachment_text_extraction_method' => 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', 'inbox_id' => 'string', 'name' => 'string', 'field' => 'string', 'match' => 'string', 'forward_to_recipients' => 'string[]', 'created_at' => '\\DateTime', 'should' => 'string', 'match_options' => '\\MailSlurp\\Models\\UpdateInboxReplierOptionsMatchOptions', 'attachment_text_extraction_method' => 'string']

$setters

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

protected static array<string|int, string> $setters = ['id' => 'setId', 'inbox_id' => 'setInboxId', 'name' => 'setName', 'field' => 'setField', 'match' => 'setMatch', 'forward_to_recipients' => 'setForwardToRecipients', 'created_at' => 'setCreatedAt', 'should' => 'setShould', 'match_options' => 'setMatchOptions', 'attachment_text_extraction_method' => 'setAttachmentTextExtractionMethod']

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

getAttachmentTextExtractionMethod()

Gets attachment_text_extraction_method

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

getAttachmentTextExtractionMethodAllowableValues()

Gets allowable values of the enum

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

getCreatedAt()

Gets created_at

public getCreatedAt() : DateTime
Return values
DateTime —

getField()

Gets field

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

getFieldAllowableValues()

Gets allowable values of the enum

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

getForwardToRecipients()

Gets forward_to_recipients

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

getInboxId()

Gets inbox_id

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

getMatch()

Gets match

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getName()

Gets name

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

getShould()

Gets should

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

getShouldAllowableValues()

Gets allowable values of the enum

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

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

setAttachmentTextExtractionMethod()

Sets attachment_text_extraction_method

public setAttachmentTextExtractionMethod(string|null $attachment_text_extraction_method) : self
Parameters
$attachment_text_extraction_method : string|null

Method for extracting text from attachments.

Return values
self —

setCreatedAt()

Sets created_at

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

created_at

Return values
self —

setField()

Sets field

public setField(string|null $field) : self
Parameters
$field : string|null

Which field to match against

Return values
self —

setForwardToRecipients()

Sets forward_to_recipients

public setForwardToRecipients(array<string|int, string> $forward_to_recipients) : self
Parameters
$forward_to_recipients : array<string|int, string>

Who to send forwarded email to

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|null $inbox_id) : self
Parameters
$inbox_id : string|null

inbox_id

Return values
self —

setMatch()

Sets match

public setMatch(string|null $match) : self
Parameters
$match : string|null

Pattern to apply to field

Return values
self —

setName()

Sets name

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

Name of inbox forwarder

Return values
self —

setShould()

Sets should

public setShould(string|null $should) : self
Parameters
$should : string|null

Comparison mode for inbox automation matching.

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

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