Mailgun API plugin for Mautic v3

Plugin provides integration with Mailgun so you can send email messages from Mautic via API using your domains.

Main Features

• Sending emails via Mailgun API.
• Multi-domains configuration.

Prerequisites

• Project was tested on Mautic 3.3.3
• During development having composer 1 setup can be handy to run scripts in composer.json.

Installing

Move to plugins directory of your Mautic installation & clone repository.

cd <mautic-dir>/plugins
git clone <repo-url> MauticMailgunMailerBundle
cd MauticMailgunMailerBundle
composer install

Create plugin enviorment file to specifiy your global config. Parameters for configruation can be found in your Mailgun Account.

cp plugin-env.php.example plugin-env.php
# edit plugin-env.php with values from your account.

Install/reload the plugin

cd <mautic-dir>
rm -rf var/cache/dev/* var/cache/prod/*
php bin/console mautic:plugins:install --env=dev  # Use mautic:plugins:reload --env=dev for update

Running the tests

[todo]

Coding style & Syntax Check

Coding style can be checked and fixed with the following commands

composer lint  # Syntax Check
composer checkcs  # Code style check
composer fixcs  # Code style fix

Deployment

Pretty much the same as installing procedure only make sure you use --env=prod switch when installing on production.

Changelog

[todo]

Documentation

• Choose Mailgun Api as the mail service, in Mautic Configuration > Email Settings. Enter default host (domain) and api key. The details you set on this tab will be used if configuration for specific domain cannot be found.
• Which of your domains will be used by this plugin to send the message depends on from field of your email.
• You can add more domains and api keys on Mailgun-multi Domains tab in Mautic Configuration.
• You should be able to edit all fields for specific domain with the exception of host. If you want to edit host field you will have to delete current configuration and add new one.
• To ensure that bounced emails are properly showed on Mautic graphs make sure you add custom header with name: TOTTGROUPID value of this field must be equivalent to email id (you can see email id in the link when you open specific record from Channels > Emails list). See the image below for an example.

Always double check that plugin is selecting expected Mailgun domain when you add new Mailgun host.

Built With

• Mautic - Marketing Automation Tool
• Composer 1 - Dependency Management

Contributing

• If you have a suggestion for the feature or improvement consider opening an issue on GitHub (just make sure the same issue does not already exists).
• If you want, you can open a pull request and I will make an effort to merge it.
• Finally if this project was helpful to you consider supporting it with a donation via PayPal. Thank you!

Versioning

[todo]

Authors

This project was adapated & is maintained by Matic Zagmajster in collaboration with Smart Octopus Solutions. For more information please see AUTHORS file.

License

This project is licensed under the GPL-3.0 License see the LICENSE file for details.

Acknowledgments

• I would like to thank colleagues at Smart Octopus Solutions for guidance on this project.