Skip to content

Commit a4a474b

Browse files
committed
Adding installation and config optioin to the readme
1 parent 26c07f2 commit a4a474b

File tree

1 file changed

+46
-3
lines changed

1 file changed

+46
-3
lines changed

README.md

+46-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,46 @@
1-
### Mautic Sparkpost Plugin
1+
# Mautic Sparkpost Plugin
22

33
This plugin enable Mautic 5 to run Sparkpost as an email transport. Features:
44
- API transport. This transport can send up to 2000 emails per API request which makes it very fast compared to SMTP.
55
- 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.
66

7+
## Installation
78

8-
#### Mautic Mailer DSN Scheme
9+
There are several ways how to install this plugin. Here are the options from best to worst.
10+
11+
### Via Composer
12+
13+
This is the best option for Mautic instances that were installed via Composer (recommended way to install Mautic)
14+
15+
Steps:
16+
1. `composer install acquia/mc-cs-plugin-sparkpost`
17+
2. `bin/console mautic:plugins:install`
18+
19+
### Via Git
20+
21+
This option is useful for development or testing of this plugin as you'll be able to checkout different branches of this repository.
22+
23+
Steps:
24+
1. `cd plugins`
25+
2. `git clone [email protected]:acquia/mc-cs-plugin-sparkpost.git SparkpostBundle`
26+
3. `cd ..`
27+
4. `bin/console mautic:plugins:install`
28+
29+
### Via SFTP
30+
31+
You should reconsider using this method as the other two above are way better, but this is also possible.
32+
33+
Steps:
34+
1. [Download this plugin](https://github.com/acquia/mc-cs-plugin-sparkpost/archive/refs/heads/main.zip)
35+
2. Rename the folder `mc-cs-plugin-sparkpost-main` to `SparkpostBundle`
36+
3. Upload this folder to the `plugins` directory of your Mautic files.
37+
4. `bin/console mautic:plugins:install`
38+
39+
## Configuration
40+
41+
After the plugin is installed go to the Mautic's global configuration, the Email settings and configure the DSN.
42+
43+
### Mautic Mailer DSN Scheme
944
`mautic+sparkpost+api`
1045

1146
#### Mautic Mailer DSN Example
@@ -16,7 +51,15 @@ This plugin enable Mautic 5 to run Sparkpost as an email transport. Features:
1651

1752
<img width="1105" alt="sparkpost-email-dsn-example" src="Assets/img/sparkpost-email-dsn-example.png">
1853

19-
### Testing
54+
### Sparkpost tracking
55+
56+
The Sparkpost tracking is disabled by default as then the email open and clicks would be tracked twice. Once by Sparkpost, second time by Mautic. This can create some unexpected behavior. The Sparkpost tracking is disabled by default, but you can enable it by adding this row to the Mautic configuration file located at `config/local.php`:
57+
58+
```php
59+
'sparkpost_tracking_enabled' => true,
60+
```
61+
62+
## Testing
2063

2164
To run all tests `composer phpunit`
2265

0 commit comments

Comments
 (0)