Documentation

TransportManager extends Manager
in package

Table of Contents

$app  : Application
The application instance.
$customCreators  : array<string|int, mixed>
The registered custom driver creators.
$drivers  : array<string|int, mixed>
The array of created "drivers".
__call()  : mixed
Dynamically call the default driver instance.
__construct()  : void
Create a new manager instance.
driver()  : mixed
Get a driver instance.
extend()  : $this
Register a custom driver creator Closure.
getDefaultDriver()  : string
Get the default mail driver name.
getDrivers()  : array<string|int, mixed>
Get all of the created "drivers".
setDefaultDriver()  : void
Set the default mail driver name.
addSesCredentials()  : array<string|int, mixed>
Add the SES credentials to the configuration array.
callCustomCreator()  : mixed
Call a custom driver creator.
createArrayDriver()  : ArrayTransport
Create an instance of the Array Swift Transport Driver.
createDriver()  : mixed
Create a new driver instance.
createLogDriver()  : LogTransport
Create an instance of the Log Swift Transport driver.
createMailDriver()  : Swift_SendmailTransport
Create an instance of the Mail Swift Transport driver.
createMailgunDriver()  : MailgunTransport
Create an instance of the Mailgun Swift Transport driver.
createMandrillDriver()  : MandrillTransport
Create an instance of the Mandrill Swift Transport driver.
createSendmailDriver()  : Swift_SendmailTransport
Create an instance of the Sendmail Swift Transport driver.
createSesDriver()  : Swift_SendmailTransport
Create an instance of the Amazon SES Swift Transport driver.
createSmtpDriver()  : Swift_SmtpTransport
Create an instance of the SMTP Swift Transport driver.
createSparkPostDriver()  : SparkPostTransport
Create an instance of the SparkPost Swift Transport driver.
guzzle()  : Client
Get a fresh Guzzle HTTP client instance.

Properties

$customCreators

The registered custom driver creators.

protected array<string|int, mixed> $customCreators = []

$drivers

The array of created "drivers".

protected array<string|int, mixed> $drivers = []

Methods

__call()

Dynamically call the default driver instance.

public __call(string $method, array<string|int, mixed> $parameters) : mixed
Parameters
$method : string
$parameters : array<string|int, mixed>
Return values
mixed

driver()

Get a driver instance.

public driver([string $driver = null ]) : mixed
Parameters
$driver : string = null
Return values
mixed

extend()

Register a custom driver creator Closure.

public extend(string $driver, Closure $callback) : $this
Parameters
$driver : string
$callback : Closure
Return values
$this

getDefaultDriver()

Get the default mail driver name.

public getDefaultDriver() : string
Return values
string

getDrivers()

Get all of the created "drivers".

public getDrivers() : array<string|int, mixed>
Return values
array<string|int, mixed>

setDefaultDriver()

Set the default mail driver name.

public setDefaultDriver(string $name) : void
Parameters
$name : string
Return values
void

addSesCredentials()

Add the SES credentials to the configuration array.

protected addSesCredentials(array<string|int, mixed> $config) : array<string|int, mixed>
Parameters
$config : array<string|int, mixed>
Return values
array<string|int, mixed>

callCustomCreator()

Call a custom driver creator.

protected callCustomCreator(string $driver) : mixed
Parameters
$driver : string
Return values
mixed

createDriver()

Create a new driver instance.

protected createDriver(string $driver) : mixed
Parameters
$driver : string
Tags
throws
InvalidArgumentException
Return values
mixed

guzzle()

Get a fresh Guzzle HTTP client instance.

protected guzzle(array<string|int, mixed> $config) : Client
Parameters
$config : array<string|int, mixed>
Return values
Client

Search results