melmartinez-dev/laravel-6-sparkpost-relay-driver

Sparkpost driver for laravel 7 and relay server

2.1.0 2020-11-05 18:29 UTC

Requires

• php: ^7.2
• guzzlehttp/guzzle: ^6.3
• laravel/framework: ^8.0
• swiftmailer/swiftmailer: ^6.0

MIT

• Mel Martinez Parra

• mail
• laravel
• sparkpost

README

Description

This package allows you to still use SparkPost as MailDriver in Laravel 6.x

This package is inspired by: https://github.com/vemcogroup/laravel-sparkpost-driver

Version

Find the correct version to use in the table below:

Laravel version	Version
6.x	1.x
7.x	2.x

Installation

You can install the package via composer:

composer require melmartinez-dev/laravel-6-sparkpost-relay-driver

The package will automatically register its service provider.

Usage

Sparkpost API options

You can define specific [SparkPost options] (https://developers.sparkpost.com/api/transmissions/#header-request-body) like open_tracking, click_tracking, transactional

EU GDPR

You are able to use the EU endpoint for Europe GDPR compliance by setting the endpoint option or the default will be used.

SparkPost (default): https://api.sparkpost.com/api/v1
SparkPost EU: https://api.eu.sparkpost.com/api/v1

Guzzle options

You are able to specify Guzzle options in the SparkPost config section guzzle.

'sparkpost' => [
    'secret' => env('SPARKPOST_SECRET'),
    'guzzle' => [
        'verify' => true,
        'decode_content' => true,
        ...
    ],
    'options' => [
        'endpoint' => env('SPARKPOST_ENDPOINT'),
        'open_tracking' => false,
        'click_tracking' => false,
        'transactional' => true,
    ],
],

Added and option for relaying servers, in the options key:

  'options' => [
        'relay'=>env('RELAY_SERVER'),
        'open_tracking' => false,
        'click_tracking' => false,
        'transactional' => true,
    ],

API Key

You will also need to add the SparkPost API Key to your environment file

SPARKPOST_SECRET=__Your_key_here__

Finally you need to set your mail driver to SparkPost. You can do this by changing the driver in config/mail.php

'driver' => env('MAIL_DRIVER', 'sparkpost'),

Or by setting the environment variable MAIL_DRIVER in your .env file

MAIL_DRIVER=sparkpost

**Laravel 7**

If you are using a clean Laravel 7.x installation its important you add the following sparkpost config in `config/mail.php` mailer section.

```php
'mailers' => [
    ...
    'sparkpost' => [
        'transport' => 'sparkpost'
    ],
    ...
],

And replace the MAIL_DRIVER from .env with MAIL_MAILER, make sure to keep the sparkpost config on config/services.php.