Download the PHP package vemcogroup/laravel-sparkpost-driver without Composer
On this page you can find all versions of the php package vemcogroup/laravel-sparkpost-driver. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download vemcogroup/laravel-sparkpost-driver
More information about vemcogroup/laravel-sparkpost-driver
Files in vemcogroup/laravel-sparkpost-driver
Package laravel-sparkpost-driver
Short Description SparkPost driver to use with Laravel 6.x|7.x|8.x|9.x|10.x
License MIT
Homepage https://github.com/vemcogroup/laravel-sparkpost-driver
Informations about the package laravel-sparkpost-driver
Laravel SparkPost Driver
Description
This package allows you to still use SparkPost as MailDriver in Laravel.
This package is inspired by: https://github.com/clarification/sparkpost-laravel-driver and updated with driver from Laravel 5.8.x
Version
Find the correct version to use in the table below:
Laravel version | Version |
---|---|
6.x | 2.x |
7.x | 3.x |
8.x | 4.x |
9.x, 10.x | 5.x |
Installation
You can install the package via composer:
If you're running an older version of Laravel, make sure you include the version number in your install. For example, for Laravel 8.x:
The package will automatically register its service provider.
Usage
You will need to configure your Laravel installation before you can use Sparkpost.
1. Update config/services.php
You will need to add Sparkpost service to your config/services.php
:
You can configure additional options there, too:
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 compliance
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
.
Just include the additional configuration in your config/services.php
.
2. Set API Key
You will also need to add the SparkPost API Key to your environment (.env
) file:
3. Set Mail Driver
You need to set your mail driver to SparkPost.
You can do this by setting the environment variable MAIL_MAILER
in your .env
file
Or, alternatively by changing the driver in config/mail.php
:
Note: If you are still using Laravel 5,
MAIL_MAILER
will be referenced asMAIL_DRIVER
.
4. Update config/mail.php
Finally, you will also need to add the sparkpost
driver to the config/mail.php
mailer section.
Note: Laravel 5 already includes this configuration, so you don't need to do it if you're using Laravel 5
Helper functions
Delete supressions
Validate single email address
Mail Subaccounts
To send an email using a SparkPost mail subaccount, add the desired subaccount id to the message header before sending:
All versions of laravel-sparkpost-driver with dependencies
guzzlehttp/guzzle Version ^7.2
laravel/framework Version ^9.0|^10.0|^11.0
symfony/mailer Version ^6.0|^7.0
ext-json Version *