class SesTransport extends Transport (View source)

Properties

array $plugins

The plug-ins registered with the transport.

from  Transport
protected SesClient $ses

The Amazon SES instance.

protected array $options

The Amazon SES transmission options.

Methods

bool
isStarted()

{@inheritdoc}

start()

{@inheritdoc}

stop()

{@inheritdoc}

bool
ping()

{@inheritdoc}

void
registerPlugin(Swift_Events_EventListener $plugin)

Register a plug-in with the transport.

void
beforeSendPerformed(Swift_Mime_SimpleMessage $message)

Iterate through registered plugins and execute plugins' methods.

void
sendPerformed(Swift_Mime_SimpleMessage $message)

Iterate through registered plugins and execute plugins' methods.

int
numberOfRecipients(Swift_Mime_SimpleMessage $message)

Get the number of recipients.

void
__construct(SesClient $ses, array $options = [])

Create a new SES transport instance.

int
send(Swift_Mime_SimpleMessage $message, $failedRecipients = null)

{@inheritdoc}

SesClient
ses()

Get the Amazon SES client for the SesTransport instance.

array
getOptions()

Get the transmission options being used by the transport.

array
setOptions(array $options)

Set the transmission options being used by the transport.

Details

bool isStarted()

{@inheritdoc}

Return Value

bool

start()

{@inheritdoc}

stop()

{@inheritdoc}

bool ping()

{@inheritdoc}

Return Value

bool

void registerPlugin(Swift_Events_EventListener $plugin)

Register a plug-in with the transport.

Parameters

Swift_Events_EventListener $plugin

Return Value

void

protected void beforeSendPerformed(Swift_Mime_SimpleMessage $message)

Iterate through registered plugins and execute plugins' methods.

Parameters

Swift_Mime_SimpleMessage $message

Return Value

void

protected void sendPerformed(Swift_Mime_SimpleMessage $message)

Iterate through registered plugins and execute plugins' methods.

Parameters

Swift_Mime_SimpleMessage $message

Return Value

void

protected int numberOfRecipients(Swift_Mime_SimpleMessage $message)

Get the number of recipients.

Parameters

Swift_Mime_SimpleMessage $message

Return Value

int

void __construct(SesClient $ses, array $options = [])

Create a new SES transport instance.

Parameters

SesClient $ses
array $options

Return Value

void

int send(Swift_Mime_SimpleMessage $message, $failedRecipients = null)

{@inheritdoc}

Parameters

Swift_Mime_SimpleMessage $message
$failedRecipients

Return Value

int

SesClient ses()

Get the Amazon SES client for the SesTransport instance.

Return Value

SesClient

array getOptions()

Get the transmission options being used by the transport.

Return Value

array

array setOptions(array $options)

Set the transmission options being used by the transport.

Parameters

array $options

Return Value

array