spaceemotion/laravel-sparkpost-options

Adds support for adding SparkPost options via the X-MSYS-API header, even when using the API implementation

1.1.1 2019-08-11 19:14 UTC

This package is auto-updated.

Last update: 2022-05-12 01:34:50 UTC


README

Latest Version on Packagist Software License Total Downloads

This package adds support for adding SparkPost messaging options. Even though Laravel allows to set global options, this package adds the functionality for per-message options via the X-MSYS-API header, even when using the integrated "send via API" implementation.

SparkPost Options documentation: https://developers.sparkpost.com/api/smtp-api.html#header-using-the-x-msys-api-custom-header

Install

Via Composer

$ composer require spaceemotion/laravel-sparkpost-options

5.4 and below: Add the ServiceProvider to your app.php:

Spaceemotion\LaravelSparkPostOptions\SparkPostConfigProvider::class,

Usage

You can either attach the mail header directly:

$mailable->withSwiftMessage(function ($message) use ($options) {
    $message->getHeaders()->addTextHeader(SparkPostConfigProvider::CONFIG_HEADER, json_encode([
        // Your options here...
    ]));
});

or via the integrated attach method:

ConfigurableTransport::attach($mailable, [
    // Your options here...
]);

License

The MIT License (MIT). Please see License File for more information.