class SparkPostTransport extends Transport (View source)

Properties

array $plugins The plug-ins registered with the transport. from Transport
protected ClientInterface $client Guzzle client instance.
protected string $key The SparkPost API key.
protected array $options The SparkPost transmission options.

Methods

isStarted()

{@inheritdoc}

from Transport
start()

{@inheritdoc}

from Transport
stop()

{@inheritdoc}

from Transport
ping()

{@inheritdoc}

from Transport
void
registerPlugin(Swift_Events_EventListener $plugin)

Register a plug-in with the transport.

from Transport
void
beforeSendPerformed(Swift_Mime_SimpleMessage $message)

Iterate through registered plugins and execute plugins' methods.

from Transport
void
sendPerformed(Swift_Mime_SimpleMessage $message)

Iterate through registered plugins and execute plugins' methods.

from Transport
int
numberOfRecipients(Swift_Mime_SimpleMessage $message)

Get the number of recipients.

from Transport
void
__construct(ClientInterface $client, string $key, array $options = [])

Create a new SparkPost transport instance.

send(Swift_Mime_SimpleMessage $message, $failedRecipients = null)

{@inheritdoc}

array
getRecipients(Swift_Mime_SimpleMessage $message)

Get all the addresses this message should be sent to.

string
getTransmissionId(Response $response)

Get the transmission ID from the response.

string
getKey()

Get the API key being used by the transport.

string
setKey(string $key)

Set the API key being used by the transport.

string
getEndpoint()

Get the SparkPost API endpoint.

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

isStarted()

{@inheritdoc}

start()

{@inheritdoc}

stop()

{@inheritdoc}

ping()

{@inheritdoc}

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(ClientInterface $client, string $key, array $options = [])

Create a new SparkPost transport instance.

Parameters

ClientInterface $client
string $key
array $options

Return Value

void

send(Swift_Mime_SimpleMessage $message, $failedRecipients = null)

{@inheritdoc}

Parameters

Swift_Mime_SimpleMessage $message
$failedRecipients

protected array getRecipients(Swift_Mime_SimpleMessage $message)

Get all the addresses this message should be sent to.

Note that SparkPost still respects CC, BCC headers in raw message itself.

Parameters

Swift_Mime_SimpleMessage $message

Return Value

array

protected string getTransmissionId(Response $response)

Get the transmission ID from the response.

Parameters

Response $response

Return Value

string

string getKey()

Get the API key being used by the transport.

Return Value

string

string setKey(string $key)

Set the API key being used by the transport.

Parameters

string $key

Return Value

string

string getEndpoint()

Get the SparkPost API endpoint.

Return Value

string

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