Inttegro PHP SDK

EmailMessage extends DomainValue
in package

FinalYes

Email content, safety scan result, and system-generated schema markup for email chimes.

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

$from  : EmailMailbox|null
From value for this email message.
$headers  : array<string, string>|null
Validated provider-neutral email headers.
$html  : string|null
Optional HTML email body before provider-specific rendering.
$replyTo  : EmailMailbox|null
Reply To value for this email message.
$safety  : EmailSafetyResult|null
Result of the email safety scan.
$schema  : EmailSchemaMarkup|null
Schema.org JSON-LD markup generated at email send time.
$subject  : string|null
Email subject.
$text  : string|null
Plain-text email body.

Methods

__construct()  : mixed
Hydrates an EmailMessage from decoded Inttegro API data.
fromArray()  : static
Creates an EmailMessage 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

$from read-only

From value for this email message.

public EmailMailbox|null $from

Optional response field. PHP type: \Inttegro\Chime\EmailMailbox|null; wire field: from_ (object).

$headers read-only

Validated provider-neutral email headers.

public array<string, string>|null $headers

Optional response field. PHP type: array<string, string>|null; wire field: headers (object).

$html read-only

Optional HTML email body before provider-specific rendering.

public string|null $html

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

$replyTo read-only

Reply To value for this email message.

public EmailMailbox|null $replyTo

Optional response field. PHP type: \Inttegro\Chime\EmailMailbox|null; wire field: reply_to (object).

$safety read-only

Result of the email safety scan.

public EmailSafetyResult|null $safety

Optional response field. PHP type: \Inttegro\Chime\EmailSafetyResult|null; wire field: safety (object).

$schema read-only

Schema.org JSON-LD markup generated at email send time.

public EmailSchemaMarkup|null $schema

Optional response field. PHP type: \Inttegro\Chime\EmailSchemaMarkup|null; wire field: schema (object).

$subject read-only

Email subject.

public string|null $subject

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

$text read-only

Plain-text email body.

public string|null $text

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

Methods

__construct()

Hydrates an EmailMessage 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 EmailMessage 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 EmailMessage 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