AXIAM PHP SDK

EmailConfig
in package
implements JsonSerializable

FinalYes

Fully resolved email configuration (all fields present).

Table of Contents

Interfaces

JsonSerializable

Properties

$createdAt  : string
$enabled  : bool
$fromEmail  : string
$fromName  : string
$id  : string
$provider  : ProviderConfigVariant
$replyTo  : string|null
$scope  : SettingsScope
$scopeId  : string
$updatedAt  : string

Methods

__construct()  : mixed
Constructs a EmailConfig.
fromArray()  : self
Rebuilds a EmailConfig from one decoded JSON object.
jsonSerialize()  : array<string, mixed>
Renders this object for `json_encode()`.
toArray()  : array<string, mixed>
Renders this object back to its wire form.

Properties

$replyTo read-only

public string|null $replyTo = null

Methods

__construct()

Constructs a EmailConfig.

public __construct(string $createdAt, bool $enabled, string $fromEmail, string $fromName, string $id, ProviderConfigVariant $provider, SettingsScope $scope, string $scopeId, string $updatedAt[, string|null $replyTo = null ]) : mixed
Parameters
$createdAt : string

the server's created_at field

$enabled : bool

the server's enabled field

$fromEmail : string

the server's from_email field

$fromName : string

the server's from_name field

$id : string

the server's id field

$provider : ProviderConfigVariant

the server's provider field

$scope : SettingsScope

the server's scope field

$scopeId : string

The org_id or tenant_id this config belongs to.

$updatedAt : string

the server's updated_at field

$replyTo : string|null = null

the server's reply_to field (optional)

fromArray()

Rebuilds a EmailConfig from one decoded JSON object.

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

The raw wire object.

Return values
self

jsonSerialize()

Renders this object for `json_encode()`.

public jsonSerialize() : array<string, mixed>

Any Sensitive it carries stays WRAPPED here, so a log line or a json_encode($model) in application code prints [SENSITIVE]. The one place a secret is revealed is ManagementTransport, on the way to the wire and nowhere else (§27.5).

Return values
array<string, mixed>

toArray()

Renders this object back to its wire form.

public toArray() : array<string, mixed>

§27.4 rule 5: a null property is OMITTED, not emitted as null. On a sparse update those two say opposite things — "leave this alone" versus "set this to nothing" — and only omission means the first.

Return values
array<string, mixed>
On this page

Search results