AXIAM PHP SDK

ProviderConfigSmtp
in package
implements ProviderConfigVariant

FinalYes

The `smtp` arm of {@see ProviderConfig} (`kind: "smtp"`).

Table of Contents

Interfaces

ProviderConfigVariant
Provider-specific connection details.

Properties

$host  : string
$port  : int
$starttls  : bool
$username  : string

Methods

__construct()  : mixed
Constructs the `smtp` arm.
fromArray()  : self
Rebuilds the `smtp` arm from one decoded JSON object.
jsonSerialize()  : array<string, mixed>
Renders this arm for `json_encode()`.
toArray()  : array<string, mixed>
Renders this arm to its wire form, re-attaching `kind: "smtp"`.

Properties

Methods

__construct()

Constructs the `smtp` arm.

public __construct(string $host, int $port, bool $starttls, string $username) : mixed
Parameters
$host : string

the server's host field

$port : int

the server's port field

$starttls : bool

Use STARTTLS (true) or implicit TLS (false).

$username : string

the server's username field

fromArray()

Rebuilds the `smtp` arm 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 arm for `json_encode()`.

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

toArray()

Renders this arm to its wire form, re-attaching `kind: "smtp"`.

public toArray() : array<string, mixed>
Return values
array<string, mixed>
On this page

Search results