Inttegro PHP SDK

EmailEvent extends DomainValue
in package

FinalYes

Email Event details associated with chime.

This immutable value hydrates decoded API snake_case data into typed camelCase properties. Use fromArray() for wire data; toArray(), array access, and JSON serialization expose the API wire representation. Nullable properties correspond to optional API fields.

Tags
see
DomainValue

Table of Contents

Properties

$bounceSubType  : string|null
Bounce Sub Type value for this email event.
$bounceType  : string|null
Bounce Type value for this email event.
$complaintSubType  : string|null
Complaint Sub Type value for this email event.
$id  : string
Unique identifier for this email event.
$occurredAt  : DateTimeImmutable
Timestamp associated with occurred.
$provider  : string
Provider value for this email event.
$providerMessageId  : string
Identifier of the related provider message.
$reason  : string|null
Reason value for this email event.
$reasonCode  : string|null
Reason Code value for this email event.
$recipient  : string|null
Recipient value for this email event.
$source  : string|null
Source value for this email event.
$suppressRecipient  : bool|null
Suppress Recipient value for this email event.
$temporary  : bool|null
Temporary value for this email event.
$type  : string
Discriminator identifying the value's API variant.

Methods

__construct()  : mixed
Hydrates an EmailEvent from decoded Inttegro API data.
fromArray()  : static
Creates an EmailEvent from its decoded API wire representation.
jsonSerialize()  : array<string, mixed>
Returns the same API wire object as `toArray()` for `json_encode()`.
offsetExists()  : bool
Reports whether a non-null property exists for a PHP or API field name.
offsetGet()  : mixed
Reads a typed property through PHP `ArrayAccess`.
offsetSet()  : void
Rejects mutation because domain values are immutable.
offsetUnset()  : void
Rejects unsetting because domain values are immutable.
toArray()  : array<string, mixed>
Converts typed properties back to the API's wire representation.

Properties

$bounceSubType read-only

Bounce Sub Type value for this email event.

public string|null $bounceSubType

Optional response field. PHP type: string|null; wire field: bounce_sub_type (string).

$bounceType read-only

Bounce Type value for this email event.

public string|null $bounceType

Optional response field. PHP type: string|null; wire field: bounce_type (string).

$complaintSubType read-only

Complaint Sub Type value for this email event.

public string|null $complaintSubType

Optional response field. PHP type: string|null; wire field: complaint_sub_type (string).

$id read-only

Unique identifier for this email event.

public string $id

Required response field. PHP type: string; wire field: id (string).

$occurredAt read-only

Timestamp associated with occurred.

public DateTimeImmutable $occurredAt

Required response field. PHP type: DateTimeImmutable; wire field: occurred_at (ISO-8601 string with UTC offset). The SDK parses the offset-bearing timestamp into an immutable PHP date-time value.

$provider read-only

Provider value for this email event.

public string $provider

Required response field. PHP type: string; wire field: provider (string).

$providerMessageId read-only

Identifier of the related provider message.

public string $providerMessageId

Required response field. PHP type: string; wire field: provider_message_id (string).

$reason read-only

Reason value for this email event.

public string|null $reason

Optional response field. PHP type: string|null; wire field: reason (string).

$reasonCode read-only

Reason Code value for this email event.

public string|null $reasonCode

Optional response field. PHP type: string|null; wire field: reason_code (string).

$recipient read-only

Recipient value for this email event.

public string|null $recipient

Optional response field. PHP type: string|null; wire field: recipient (string).

$source read-only

Source value for this email event.

public string|null $source

Optional response field. PHP type: string|null; wire field: source (string).

$suppressRecipient read-only

Suppress Recipient value for this email event.

public bool|null $suppressRecipient

Optional response field. PHP type: bool|null; wire field: suppress_recipient (boolean).

$temporary read-only

Temporary value for this email event.

public bool|null $temporary

Optional response field. PHP type: bool|null; wire field: temporary (boolean).

$type read-only

Discriminator identifying the value's API variant.

public string $type

Required response field. PHP type: string; wire field: type (string).

Methods

__construct()

Hydrates an EmailEvent from decoded Inttegro API data.

public __construct(array<string, mixed> $data) : mixed
Parameters
$data : array<string, mixed>

Wire object keyed by snake_case API field names.

fromArray()

Creates an EmailEvent from its decoded API wire representation.

public static fromArray(array<string, mixed> $data) : static
Parameters
$data : array<string, mixed>

Wire object keyed by snake_case API field names.

Return values
static —

A typed, immutable EmailEvent value.

jsonSerialize()

Returns the same API wire object as `toArray()` for `json_encode()`.

public jsonSerialize() : array<string, mixed>
Return values
array<string, mixed>

offsetExists()

Reports whether a non-null property exists for a PHP or API field name.

public offsetExists(mixed $offset) : bool

Both paymentId and payment_id address the same typed property.

Parameters
$offset : mixed

PHP camelCase or wire snake_case field name.

Return values
bool

offsetGet()

Reads a typed property through PHP `ArrayAccess`.

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed

PHP camelCase or wire snake_case field name.

Return values
mixed —

The PHP-native property value.

offsetSet()

Rejects mutation because domain values are immutable.

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed

Ignored field name.

$value : mixed

Ignored replacement value.

Tags
throws
LogicException

Always.

offsetUnset()

Rejects unsetting because domain values are immutable.

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed

Ignored field name.

Tags
throws
LogicException

Always.

toArray()

Converts typed properties back to the API's wire representation.

public toArray() : array<string, mixed>

Property names become snake_case. Nested values, arrays, backed enums, and timestamps are normalized recursively so the result is safe to pass to json_encode().

Return values
array<string, mixed> —

The recursively normalized API object.

On this page

Search results