class ArrayTransport extends Transport (View source)

Properties

array $plugins

The plug-ins registered with the transport.

from  Transport
protected Collection $messages

The collection of Swift Messages.

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()

Create a new array transport instance.

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

{@inheritdoc}

messages()

Retrieve the collection of messages.

flush()

Clear all of the messages from the local collection.

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()

Create a new array transport instance.

Return Value

void

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

{@inheritdoc}

Parameters

Swift_Mime_SimpleMessage $message
$failedRecipients

Return Value

int

Collection messages()

Retrieve the collection of messages.

Return Value

Collection

Collection flush()

Clear all of the messages from the local collection.

Return Value

Collection