README

Registers sparkpost as a Laravel mail driver, using hampel/sparkpost-transport to send and hampel/sparkpost to talk to the API.

By Simon Hampel

Installation

composer require hampel/sparkpost-laravel

The service provider is registered by package discovery. There is no configuration file to publish: the two files this needs already exist in every Laravel application.

Configuration

Add the mailer to config/mail.php:

'mailers' => [
    'sparkpost' => [
        'transport' => 'sparkpost',
    ],
],

And the credentials to config/services.php:

'sparkpost' => [
    'secret' => env('SPARKPOST_SECRET'),
    'region' => env('SPARKPOST_REGION'),   // optional; "eu" for the EU tenancy
],

Then set MAIL_MAILER=sparkpost. Anything set on the mailer in config/mail.php overrides services.sparkpost, so two mailers can run against different SparkPost accounts.

Transmission options

options is applied to every message the mailer sends:

'sparkpost' => [
    'secret' => env('SPARKPOST_SECRET'),
    'options' => [
        'open_tracking' => false,
        'click_tracking' => false,
        'transactional' => true,
    ],
],

Leaving these unset is not the same as setting them false. SparkPost applies the account default instead, so an application that wants click tracking off has to say so — otherwise every link in every email is rewritten through SparkPost's domain. Likewise transactional: mail that is not marked transactional is filtered against the non-transactional suppression list, so someone who unsubscribed from a newsletter stops receiving password resets.

Options can go on the mailer instead, which is how two mailers send with different tracking against one account:

'mailers' => [
    'sparkpost' => ['transport' => 'sparkpost'],
    'sparkpost-bulk' => [
        'transport' => 'sparkpost',
        'options' => ['transactional' => false, 'ip_pool' => 'bulk'],
    ],
],

The mailer's array replaces the one in services.sparkpost rather than merging into it, the same as every other key — so repeat any option you still want. Anything a message sets for itself wins over both.

The bounce address

return_path is Laravel's own setting, not one this package adds. Set it in config/mail.php and it applies to every message the application sends:

'return_path' => [
    'address' => env('MAIL_RETURN_PATH'),
],

Laravel applies it in Mailer::createMessage(), so it covers Mailables, Mail::raw(), notifications and queued mail alike. Setting return_path on a mailer in mail.mailers overrides the global value for that mailer.

Two things to know:

It is sent only when it differs from the From address. Symfony falls back to the From when no return path is set, and sending that as the bounce address would move bounces off SparkPost's own bounce domain.
The domain must be a verified bounce domain on the SparkPost account. SparkPost accepts a transmission naming an unverified one and does not deliver it.

Sending every message from one address on one domain, and using Reply-To where replies belong elsewhere, keeps SPF and DKIM aligned with that domain.

What you get from the transport

Everything in hampel/sparkpost-transport applies here, and two parts of it are worth knowing about:

A transmission SparkPost accepts with no accepted recipients is a failed send, and raises a TransportException rather than reporting success.
A partial rejection is logged rather than raised. This package wires Laravel's logger into the transport, so those warnings go wherever the application's logs go.

To send SparkPost-specific fields - campaigns, metadata, substitution data, stored templates - build a SparkPostEmail and pass it through the Symfony transport directly; see that package's README.

Using your own HTTP client

The transport takes whatever PSR-18 client the container has. Bind one to configure a proxy, a timeout or retry middleware:

$this->app->bind(\Psr\Http\Client\ClientInterface::class, fn () => new \GuzzleHttp\Client([
    'timeout' => 10,
]));

Laravel binds none of the PSR-18 or PSR-17 interfaces by default, so without a binding this package constructs a Guzzle client itself.

Laravel versions

^12.0|^13.0, and the suite runs against both under Orchestra Testbench.

Licence

MIT. See LICENSE.md.

hampel / sparkpost-laravel

Maintainers

Package info

Statistics

Security