class SparkPostTransport extends Transport (View source)
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. |
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. |
{@inheritdoc}
{@inheritdoc}
{@inheritdoc}
{@inheritdoc}
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.
Note that SparkPost still respects CC, BCC headers in raw message itself.
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.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.8/Illuminate/Mail/Transport/SparkPostTransport.html