hampel/symfonymailer-sparkpost

A Symfony Mailer Transport for SparkPost

1.1.2 2024-10-04 12:04 UTC

Requires

• php: >=7.2.5
• symfony/mailer: ^4.4|^5.0|^6.0

Requires (Dev)

• guzzlehttp/guzzle: ^7.0
• phpunit/phpunit: ^10.0

MIT

• Simon Hampel

README

By Simon Hampel

Description

Standalone implementation of Symfony Mailer SparkPost Driver based on https://github.com/gam6itko/sparkpost-mailer - but using GuzzleHttp as the HTTP client rather than Symfony HTTP Client.

Installation

You can install the package via composer:

composer require hampel/symfonymailer-sparkpost

Usage

The SparkPost options available are defined in the API: SparkPost options

$sparkpostOptions = [
	'options' => [
		'open_tracking' => false,
		'click_tracking' => true,
		'transactional' => true,
	],
];

$transport = new SparkPostApiTransport(
	'MYSPARKPOSTAPIKEY', 
	new GuzzleHttp\Client
);

new SparkPostEmail();
$email->setOptions([
    'click_tracking' => false,
    'open_tracking' => true,
    'transactional' => true,
]);
$email->setCampaignId('my-campaign');
$email->from('[e-mail]');
$email->to('[e-mail]');
$email->subject('My subject');
$email->text(...);
$email->html(...);

$result = $transport->send($email);