Mautic bundle that provides integration to the newsletter service EditNews
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Api
Assets/img
Config
Form/Type
Integration
Translations/en_US
Views/FormTheme/EmailMarketing
KntntEmailMarketingBundle.php
LICENSE
README.md

README.md

Kntnt's Email Marketing Bundle for Mautic

Plugin that provides integration to the newsletter service EditNews for the open source marketing automation system Mautic,

Description

Mautic is an open source marketing automation system, and EditNews is an email marketing software as a service. This plugin allows Mautic to push contacts to an address list of EditNews.

Requirements

This plugin have some requirements…

  1. Working Mautic 2.13.1 or later installation.
  2. Mautic must run on PHP7.
  3. You must have PHP's SOAP extension installed. To install it on Ubuntu and derivatives (e.g. Kubuntu) run sudo apt install php7.0-soap in the terminal. On RedHat and derivatives (e.g. Fedora and Centos) run yum install php-soap. Restart Apache, PHP-FPM, PHP FastCGI or whatever you use to manage your PHP processes.

Installation

Install this plugin by following Mautic's standard procedure:

  1. Download or clone this bundle into theplugins folder of your Mautic installation.
  2. Delete the production cache of your Mautic installation. You can do that either by running app/console cache:clear --env=prod from the root of your Mautic installation, or by manually delete app/cache/prod.
  3. Log in to Mautic. Click the gear icon in the upper right corner. Choose Click Plugins from the menu appearing.
  4. Click on the button Install/Upgrade Plugins in the upper right corner.

You should now see EditNews among the other plugins. Go ahead and configure it.

Configuration

Before configuring the plugin, make sure you have following information at hand:

  1. Your EditNews API key. If you don't have one, contact EditNews support and ask for an API key.
  2. The EditNews name of the address list onto which you want the plugin to push contacts.

With this information you can follow these step-by-step instructions to configure the plugin:

  1. Log in to Mautic. Click the gear icon in the upper right corner. Choose Click Plugins from the menu appearing.
  2. Click on the EditNews plugin.
  3. In the dialogue showing, go to tab Enabled/Auth, fill in your API key on the tab, and click the Apply button.
  4. Go to the tab Features and select your address list.
  5. Go to the tab Contact Mapping and select a Mautic fields for each Integration field. Only the Email field is mandatory.
  6. Click on the Save & Close button.

Usage

Before you push a contact to EditNews, make sure you have following information at hand:

  1. The EditNews name of the address list onto which you want the plugin to push contacts.
  2. The EditNews name of the welcome letter on successful sign up.
  3. The EditNews name of the sender of the welcome letter.

With this information you can follow these step-by-step instructions to make use of the plugin:

  1. Add a Push contect to integration action to a campaign or form in Mautic.
  2. Enter a name, e.g. "Push to EditNews".
  3. Enter an optionally description.
  4. Click in the Integration filed and select EditNews.
  5. Click in the List field and select the name of the list to which you want to push the contact.
  6. Enter the subjectline of the verification email sent.
  7. Enter the URL of the page to which you want contacts to be redirected once they have verified their subscription.
  8. Click in the Welcome letter field and select the name of the welcome letter you want to be sent to new contacts once they have verified their email address. You can leave this field empty.
  9. Click in the Sender field and select the name of the sender of the welcome letter.

Frequently Asked Questions

Why can't I select a verification email?

Currently, EditNews API don't provide means to select a verification email. A standard verification emai is sent instead.

It doesn't work! What to do?

There are two things you always should test first of all: purge cache and check file permissions. Often that solves the issue. If not, take a look in both Mautic's log file (located in app/logs) and in your web server's error log, to see if there is any relevant error messages that can help you.

See also Mautic's documentation on troubleshooting.

How can I get help?

If you have a questions about the plugin, and cannot find an answer here, start by looking at issues and pull requests. If you still cannot find the answer, feel free to ask in the the plugin's issue tracker at Github.

How can I report a bug?

If you have found a potential bug, please report it on the plugin's issue tracker at Github.

How can I contribute?

Contributions to the code or documentation are much appreciated.

If you are unfamiliar with Git, please date it as a new issue on the plugin's issue tracker at Github.

If you are familiar with Git, please do a pull request.

Changelog

1.0.3

  • Added verify subject field.
  • Updated documentation.

1.0.2

  • Updated documentation.

1.0.1

  • Fixed bug: Mautic requires a dummy username together with password.
  • Improved documentation.

1.0.0

  • Initial release. Fully functional bundle.