Thanks for purchasing the ClearOut plugin for Mautic.

Installation:

Like any Mautic plugin you will unzip the plugin.

Copy the ClearOut plugin folder to the folder plugins, in the Mautic installation.  It will be in the root or first level of the installation.

Clear the cache folder from Mautic using the standard procedure:

The easiest is to go to the /app/cache folder and delete its content. If you want to do it via CLI command, navigate to the Mautic root folder and run rm -rf app/cache/* . The new cache files will generate itself after the next Mautic refresh in the browser.

Now open Mautic and login.

On the dashboard click the gear icon in the top right.   This opens the configuration menu, click plugins.

Select the ClearOut plugin by clicking on it.

You will now have a box with two entries that you must make.

 

First is the ClearOut API token.

Login to your ClearOut.io account.

Go to your profile page and generate an API token by clicking the button if one is not already created.

Copy this API Token to the Token field on the Mautic Plugin Configuration.

Next enter your Gautit License into the License Key.

Click Apply.

Click the Features tab to get to this screen.

 

 

If you would like the plugin to process all existing names in the contact list, check this box.  If you only want to process new names, make sure the box is unchecked.

Installation is now complete.

Using the plugin:

New contacts and imported contacts will be processed through ClearOut.

Add a contact with an email address into Mautic.

Then open the contact from the contacts menu in Mautic, you will see a couple of tags added to the contact.

Existing tags will not be modified.

Tags that can be added:

  • clearComplete – The plugin called ClearOut and received a result.
  • clearPending – The plugin called ClearOut and did not receive a result

If the clearComplete tag is in place, then you will also have one of these additional tags.

  • clearInvalid
  • clearValid
  • clearCatch_all
  • clearUnknown

You can use these tags to segment your contacts.  See the ClearOut documentation for their explanation of the returned results.  documentation

If an error is returned, or you have run out of daily credits or similar error, the entry will be tagged with clearPending.

The plugin utilizes a cron job to resubmit the emails until they are validated.

php path/to/mautic/app/console clearout:validate:email

Set it to run once a day at a minimum, that will give ClearOut a chance to reset its daily count if you are on a plan that has daily restrictions.   We set most of our clients to run every hour, remember this is just for contacts that did not process when they were entered.

That’s it!  Thanks again for using our plugin.   Let us know what other plugins you would like to see.