Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lekoala/silverstripe-sparkpost
Use SparkPost in SilverStripe
https://github.com/lekoala/silverstripe-sparkpost
email silverstripe silverstripe-4 silverstripe-5 silverstripe-module sparkpost
Last synced: 8 days ago
JSON representation
Use SparkPost in SilverStripe
- Host: GitHub
- URL: https://github.com/lekoala/silverstripe-sparkpost
- Owner: lekoala
- License: mit
- Created: 2016-04-16T08:56:03.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-11-12T23:19:51.000Z (about 2 months ago)
- Last Synced: 2024-12-12T08:41:58.558Z (16 days ago)
- Topics: email, silverstripe, silverstripe-4, silverstripe-5, silverstripe-module, sparkpost
- Language: PHP
- Homepage:
- Size: 463 KB
- Stars: 6
- Watchers: 4
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# SilverStripe SparkPost module
[](https://scrutinizer-ci.com/g/lekoala/silverstripe-sparkpost/?branch=master)
[](https://scrutinizer-ci.com/g/lekoala/silverstripe-sparkpost/?branch=master)
[](https://scrutinizer-ci.com/g/lekoala/silverstripe-sparkpost/build-status/master)
[](https://codecov.io/github/lekoala/silverstripe-sparkpost?branch=master)
[](https://packagist.org/packages/lekoala/silverstripe-sparkpost)
[](//packagist.org/packages/lekoala/silverstripe-sparkpost)
[](https://packagist.org/packages/lekoala/silverstripe-sparkpost)
[](https://packagist.org/packages/lekoala/silverstripe-sparkpost)
[](https://packagist.org/packages/lekoala/silverstripe-sparkpost)
[](https://packagist.org/packages/lekoala/silverstripe-sparkpost)
## Setup
Define in your .env file the following variable
SPARKPOST_API_KEY='YOUR_API_KEY_HERE'
or by defining the api key in your config.yml
```yaml
LeKoala\SparkPost\SparkPostHelper:
api_key: "YOUR_API_KEY_HERE"
```
This module uses a custom client (not the official PHP SDK).
You can also autoconfigure the module with the following environment variables
# Will log emails in the temp folders
SPARKPOST_ENABLE_LOGGING=true
# Will disable sending (useful in development)
SPARKPOST_SENDING_DISABLED=true
By defining the Api Key, the module will register a new transport that will be used to send all emails.
If you're using the SparkPost EU service you can change the API endpoint
# Will use https://api.eu.sparkpost.com/api/v1
SPARKPOST_EU=true
## Register the new mailer
If you define the SPARKPOST_API_KEY variable, the mailer transport will be automatically registered.
Otherwise, you need to call the following line:
```php
SparkPostHelper::registerTransport();
```
## Admin sender
By default in SilverStripe, emails without a from email will use the Email::admin_email value.
This is not convenient for websites using a value taken from the SiteConfig, as resolved with
`SparkPostHelper::resolveDefaultFromEmail`.
The SparkPostApiTransport can automatically take care of that and replace any admin email
with the set value using the following config flag:
```yaml
LeKoala\SparkPost\SparkPostHelper:
override_admin_email: true
```
Make sure to set this after having processed the sparkpost config.
## Check if emails can be used as sender
As a convenience, this library offers an utility `SparkPostHelper::isEmailDomainReady` to help
you determine if an email is ready to be used as a sender.
Please note that this function makes an api call so you may not want to use this to often. It
is a better to use this on verification screens or as part of a validation workflow.
## Subaccounts support
If you use a master api key, but need to [limit data access](https://developers.sparkpost.com/api/#/introduction/subaccounts),
you can configure a subaccount id
SPARKPOST_SUBACCOUNT_ID=1234;
or through the YML config.
## SparkPost integration
This module create a new admin section that allows you to:
- List all messages events and allow searching them
- Have a settings tab to list and configure sending domains and webhook
NOTE : Make sure that you have a valid api key (not a subaccount key) to access
features related to installation of the webhook through the CMS.
Note that by default the messages are cached (or not) according to config. You
can disable this with the following env key
SPARKPOST_DISABLE_CACHE=true
## Setting tags or metadata
By using custom headers you can pass parameters to the api by following the
same principle than the SMTP api.
The main way to pass parameters is to add a json encoded string through the
X-MSYS-API header, but you can also use that Mandrill compatiblity layer.
For full details, look at the [documentation](https://developers.sparkpost.com/api/smtp/)
```php
$email = new Email();
$email->setSubject($sellerTitle . ' - Invoice - ' . $date);
$email->setBody($body);
// Through Mandrill compat layer
$email->getHeaders()->addTextHeader('X-MC-Metadata', json_encode(['RecordID' => $this->ID]));
// Or use M-SYS header
$email->getHeaders()->addTextHeader('X-MSYS-API', json_encode(['metadata' => ['RecordID' => $this->ID]]));
```
## Webhooks
From the SparkPost Admin, you can setup a webhook for your website. This webhook
will be called and SparkPostController will take care of handling all events
for you. It is registered under the \_\_sparkpost/ route.
By default, SparkPostController will do nothing. Feel free to add your own
extensions to SparkPostController to define your own rules, like "Send an
email to the admin when a receive a spam complaint".
SparkPostController provides the following extension point for all events:
- onAnyEvent
And the following extensions points depending on the type of the event:
- onEngagementEvent
- onGenerationEvent
- onMessageEvent
- onUnsubscribeEvent
You can also inspect the whole payload and the batch id with
- beforeProcessPayload : to check if a payload has been processed
- afterProcessPayload : to mark the payload has been processed or log information
You can test if your extension is working properly by visiting /\_\_sparkpost/test
if your site is in dev mode. It will load sample data from the API.
Please ensure that the url for the webhook is properly configured if required
by using the following configuration
```yaml
LeKoala\SparkPost\SparkPostAdmin:
webhook_base_url: "https://my.domain.com/"
```
You can also define the following environment variable to log all incoming payload into a given
directory. Make sure the directory exists. It is relative to your base folder.
SPARKPOST_WEBHOOK_LOG_DIR='_incoming'
Please also pay attention to the fact that the webhook is called for ALL events
of your SparkPost account, regardless of the fact of which API key generated the transmission.
To help you overcome this, if a subaccount id is defined, events will be filtered according
to this subaccount.
## Preventing spam
Make sure you have properly configured your [SPF](https://tools.sparkpost.com/spf/builder) and DKIM records for your domain.
mydomain.com TXT "v=spf1 include:myauthorizeddomain.com include:sparkpostmail.com ~all”
Create a [DMARC record](https://www.zerobounce.net/services/dmarc-generator.html). See [why this is important](https://support.google.com/a/answer/2466563?hl=en).
_dmarc.mydomain.com. 3600 IN TXT "v=DMARC1; p=quarantine; sp=quarantine; rf=afrf; pct=100; ri=86400;"
Leave provide_plain option to true or provide plain content for your emails
Use [Mail Tester](http://www.mail-tester.com/) to troubleshoot your issues
## Inlining styles
Although SparkPost can inline styles for you, it may not work properly for complex
style sheet, such as Foundation Emails. This is why the package pelago\emogrifier
is not required by default and styles are inlined in php to get the best results.
If you want to restore built-in functionnality, use this:
```yaml
LeKoala\SparkPost\SparkPostHelper:
inline_styles: false
default_params:
inlineCss: true
```
# Migration from Swift Mailer
SilverStripe 5 replaced swift mailer by symfony/mailer
Make sure to read the docs
https://docs.silverstripe.org/en/5/developer_guides/email/
https://symfony.com/doc/current/mailer.html
## Compatibility
Tested with SilverStripe 5+
For 4.9+ compatibility, use branch 3
For 4.x compatibility, use branch 2
For 3.x compatibility, use branch 1
## Maintainer
LeKoala - [email protected]