SparkPostTransport
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
Register a plug-in with the transport.
Iterate through registered plugins and execute plugins' methods.
Iterate through registered plugins and execute plugins' methods.
Get the number of recipients.
Create a new SparkPost transport instance.
{@inheritdoc}
Get all the addresses this message should be sent to.
Get the transmission ID from the response.
Get the API key being used by the transport.
Set the API key being used by the transport.
Get the SparkPost API endpoint.
Get the transmission options being used by the transport.
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.
protected void
beforeSendPerformed(Swift_Mime_SimpleMessage $message)
Iterate through registered plugins and execute plugins' methods.
protected void
sendPerformed(Swift_Mime_SimpleMessage $message)
Iterate through registered plugins and execute plugins' methods.
protected int
numberOfRecipients(Swift_Mime_SimpleMessage $message)
Get the number of recipients.
void
__construct(ClientInterface $client, string $key, array $options = [])
Create a new SparkPost transport instance.
send(Swift_Mime_SimpleMessage $message, $failedRecipients = null)
{@inheritdoc}
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.
protected 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.