acquia/mc-cs-plugin-sparkpost

Sparkpost Mailer Plugin for Mautic

dev-main 2024-07-25 16:06 UTC

Requires

• php: >=8.0.0
• mautic/core-lib: ^5.0

GPL-3.0-or-later

• plugin
• integration
• Mautic

README

Mautic Sparkpost Plugin

This plugin enable Mautic 5 to run Sparkpost as an email transport. Features:

• API transport. This transport can send up to 2000 emails per API request which makes it very fast compared to SMTP.
• Bounce webhook handling. This plugin will unsubscribe contacts in Mautic based on the hard bounces while Sparkpost will take care of the soft bounce retrieals.

Mautic Mailer DSN Scheme

mautic+sparkpost+api

Mautic Mailer DSN Example

'mailer_dsn' => 'mautic+sparkpost+api://:<api_key>@default?region=<region>',

• api_key: Get Sparkpost API key from https://app.sparkpost.com/account/api-keys/create
• options:
  • region: us (SparkPost https://api.sparkpost.com/api/v1) OR eu (SparkPost EU https://api.eu.sparkpost.com/api/v1)

Testing

To run all tests composer phpunit

To run unit tests composer unit

To run functional tests composer functional

Static analysis tools

To run fixes by friendsofphp/php-cs-fixer composer fixcs

To run phpstan composer phpstan