Documentation

WebhookNewEmailPayload
in package
implements ModelInterface, ArrayAccess, JsonSerializable

WebhookNewEmailPayload Class Doc Comment

Tags
category

Class

description

NEW_EMAIL webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is received by the inbox that your webhook is attached to. Use the email ID to fetch the full email body or attachments.

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
EVENT_NAME_BOUNCE  = 'BOUNCE'
EVENT_NAME_BOUNCE_RECIPIENT  = 'BOUNCE_RECIPIENT'
EVENT_NAME_DELIVERY_STATUS  = 'DELIVERY_STATUS'
EVENT_NAME_EMAIL_OPENED  = 'EMAIL_OPENED'
EVENT_NAME_EMAIL_READ  = 'EMAIL_READ'
EVENT_NAME_EMAIL_RECEIVED  = 'EMAIL_RECEIVED'
EVENT_NAME_NEW_ATTACHMENT  = 'NEW_ATTACHMENT'
EVENT_NAME_NEW_CONTACT  = 'NEW_CONTACT'
EVENT_NAME_NEW_EMAIL  = 'NEW_EMAIL'
EVENT_NAME_NEW_SMS  = 'NEW_SMS'
$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
getAttachmentMetaDatas()  : array<string|int, AttachmentMetaData>
Gets attachment_meta_datas
getBcc()  : array<string|int, string>
Gets bcc
getCc()  : array<string|int, string>
Gets cc
getCreatedAt()  : DateTime
Gets created_at
getDomainId()  : string|null
Gets domain_id
getEmailId()  : string
Gets email_id
getEventName()  : string
Gets event_name
getEventNameAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getFrom()  : string
Gets from
getInboxId()  : string
Gets inbox_id
getMessageId()  : string
Gets message_id
getModelName()  : string
The original name of the model.
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
getWebhookId()  : string
Gets webhook_id
getWebhookName()  : string|null
Gets webhook_name
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
setAttachmentMetaDatas()  : self
Sets attachment_meta_datas
setBcc()  : self
Sets bcc
setCc()  : self
Sets cc
setCreatedAt()  : self
Sets created_at
setDomainId()  : self
Sets domain_id
setEmailId()  : self
Sets email_id
setEventName()  : self
Sets event_name
setFrom()  : self
Sets from
setInboxId()  : self
Sets inbox_id
setMessageId()  : self
Sets message_id
setSubject()  : self
Sets subject
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTo()  : self
Sets to
setWebhookId()  : self
Sets webhook_id
setWebhookName()  : self
Sets webhook_name
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 = ['message_id' => 'messageId', 'webhook_id' => 'webhookId', 'event_name' => 'eventName', 'webhook_name' => 'webhookName', 'inbox_id' => 'inboxId', 'domain_id' => 'domainId', 'email_id' => 'emailId', 'created_at' => 'createdAt', 'to' => 'to', 'from' => 'from', 'cc' => 'cc', 'bcc' => 'bcc', 'subject' => 'subject', 'attachment_meta_datas' => 'attachmentMetaDatas']

$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 = ['message_id' => 'getMessageId', 'webhook_id' => 'getWebhookId', 'event_name' => 'getEventName', 'webhook_name' => 'getWebhookName', 'inbox_id' => 'getInboxId', 'domain_id' => 'getDomainId', 'email_id' => 'getEmailId', 'created_at' => 'getCreatedAt', 'to' => 'getTo', 'from' => 'getFrom', 'cc' => 'getCc', 'bcc' => 'getBcc', 'subject' => 'getSubject', 'attachment_meta_datas' => 'getAttachmentMetaDatas']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['message_id' => null, 'webhook_id' => 'uuid', 'event_name' => null, 'webhook_name' => null, 'inbox_id' => 'uuid', 'domain_id' => 'uuid', 'email_id' => 'uuid', 'created_at' => 'date-time', 'to' => null, 'from' => null, 'cc' => null, 'bcc' => null, 'subject' => null, 'attachment_meta_datas' => 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 = 'WebhookNewEmailPayload'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['message_id' => false, 'webhook_id' => false, 'event_name' => false, 'webhook_name' => true, 'inbox_id' => false, 'domain_id' => true, 'email_id' => false, 'created_at' => false, 'to' => false, 'from' => false, 'cc' => false, 'bcc' => false, 'subject' => true, 'attachment_meta_datas' => 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 = ['message_id' => 'string', 'webhook_id' => 'string', 'event_name' => 'string', 'webhook_name' => 'string', 'inbox_id' => 'string', 'domain_id' => 'string', 'email_id' => 'string', 'created_at' => '\\DateTime', 'to' => 'string[]', 'from' => 'string', 'cc' => 'string[]', 'bcc' => 'string[]', 'subject' => 'string', 'attachment_meta_datas' => '\\MailSlurp\\Models\\AttachmentMetaData[]']

$setters

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

protected static array<string|int, string> $setters = ['message_id' => 'setMessageId', 'webhook_id' => 'setWebhookId', 'event_name' => 'setEventName', 'webhook_name' => 'setWebhookName', 'inbox_id' => 'setInboxId', 'domain_id' => 'setDomainId', 'email_id' => 'setEmailId', 'created_at' => 'setCreatedAt', 'to' => 'setTo', 'from' => 'setFrom', 'cc' => 'setCc', 'bcc' => 'setBcc', 'subject' => 'setSubject', 'attachment_meta_datas' => 'setAttachmentMetaDatas']

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>
Return values
array<string|int, string> —

getCc()

Gets cc

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

getEventNameAllowableValues()

Gets allowable values of the enum

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

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

getWebhookName()

Gets webhook_name

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

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

setAttachmentMetaDatas()

Sets attachment_meta_datas

public setAttachmentMetaDatas(array<string|int, AttachmentMetaData> $attachment_meta_datas) : self
Parameters
$attachment_meta_datas : array<string|int, AttachmentMetaData>

List of attachment meta data objects if attachments present

Return values
self —

setBcc()

Sets bcc

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

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> $cc) : self
Parameters
$cc : array<string|int, string>

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

Date time of event creation

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 an email

Return values
self —

setEmailId()

Sets email_id

public setEmailId(string $email_id) : self
Parameters
$email_id : string

ID of the email that was received. Use this ID for fetching the email with the EmailController.

Return values
self —

setEventName()

Sets event_name

public setEventName(string $event_name) : self
Parameters
$event_name : string

Name of the event type webhook is being triggered for.

Return values
self —

setFrom()

Sets from

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

Who the email was sent from. An email address - see fromName for the sender name.

Return values
self —

setInboxId()

Sets inbox_id

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

Id of the inbox

Return values
self —

setMessageId()

Sets message_id

public setMessageId(string $message_id) : self
Parameters
$message_id : string

Idempotent message ID. Store this ID locally or in a database to prevent message duplication.

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 —

setWebhookId()

Sets webhook_id

public setWebhookId(string $webhook_id) : self
Parameters
$webhook_id : string

ID of webhook entity being triggered

Return values
self —

setWebhookName()

Sets webhook_name

public setWebhookName(string|null $webhook_name) : self
Parameters
$webhook_name : string|null

Name of the webhook being triggered

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