SetOrgEmailConfig
in package
implements
JsonSerializable
Input for setting organization-level email config.
This is a REPLACEMENT body (§27.4 rule 5): every field is required, so omitting one is a constructor error rather than a silent erasure server-side.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $enabled : bool
- $fromEmail : string
- $fromName : string
- $provider : ProviderConfigVariant
- $replyTo : string|null
Methods
- __construct() : mixed
- Constructs a SetOrgEmailConfig.
- fromArray() : self
- Rebuilds a SetOrgEmailConfig 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
$enabled read-only
public
bool
$enabled
$fromEmail read-only
public
string
$fromEmail
$fromName read-only
public
string
$fromName
$provider read-only
public
ProviderConfigVariant
$provider
$replyTo read-only
public
string|null
$replyTo
= null
Methods
__construct()
Constructs a SetOrgEmailConfig.
public
__construct(bool $enabled, string $fromEmail, string $fromName, ProviderConfigVariant $provider[, string|null $replyTo = null ]) : mixed
Parameters
- $enabled : bool
-
the server's
enabledfield - $fromEmail : string
-
the server's
from_emailfield - $fromName : string
-
the server's
from_namefield - $provider : ProviderConfigVariant
-
the server's
providerfield - $replyTo : string|null = null
-
the server's
reply_tofield (optional)
fromArray()
Rebuilds a SetOrgEmailConfig from one decoded JSON object.
public
static fromArray(array<string, mixed> $data) : self
Parameters
- $data : array<string, mixed>
-
The raw wire object.
Return values
selfjsonSerialize()
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.