Email Protector

Safely cloak email addresses in Joomla!

  • Last updated: 26 Sep 2020
  • Version: 4.5.0
  • Type: System plugin
  • Joomla rating: 100%

Tutorial for Email Protector

Introduction

Regular Labs Email Protector is a Joomla! system plugin that cloaks email addresses in your Joomla! website, making them unreadable for spambots.

Email Protector is a replacement for the Joomla! core email cloaking plugin, and it's completely free.

With this plugin, email addresses are cloaked in a safer and more stable way compared to the core plugin. Also, Email Protector takes effect across the entire website, as opposed to the core plugin which only cloaks email addresses inside articles content.

How to use it

Using Email Protector is extremely simple. After installing it, it's already automatically enabled. That's it, you don't need to do anything else!

Email addresses will be now safely cloaked across your Joomla site.

In addition, you will not need to disable the core "Email Cloaking" plugin, as Email Protector will automatically disable the Joomla core plugin on installation.

Comparison with Core Plugin

The core "Email Cloaking" plugin has a couple of issues and shortcomings. Email Protector by Regular Labs, instead, solves all of these issues:

No more javascript issues

The core email cloaking plugin uses the javascript document.write() method, which is outdated and can cause issues with other javascripts.
It also relies solely on javascript to cloak the email addresses, which means that if the javascript fails for whatever reason, you cannot see the email address at all.

Email Protector cloaks the email addresses in a different manner which solves this issue.
It uses both CSS and javascript to cloak the email addresses. When javascript fails to load, it will still display the email address to the visitor, but in a cloaked manner.

Not only in articles

The core email cloaking plugin is a content plugin. This means it only works in articles and content that is specifically passed through the content plugins. As a result this often means that email addresses in modules and 3rd party extensions are not cloaked.

Email Protector is a system plugin and is written in a way that it will cloak email addresses anywhere in your entire website - so also in modules, components and 3rd party extensions.

Leave it like it is

The core email cloaking plugin has the option to convert all email addresses to mailto links or display them as plain text.

Email Protector has an extra (default) setting to leave the email addresses as you create them in the content.
So if the email address is a mailto link, it leaves it as a link. And when it is only text, it will leave it like that.

Feature Comparison

Email Protector by Regular Labs offers several advantages compared to the Joomla core "Email Cloaking" plugin.

Here is a table that compares the features of the core plugin with Email Protector:

 Core PluginEmail Protector
 Included in JoomlaFREE
Cloak email addresses inside articles Yes Yes
Option to display email addresses as mailto links or as plain text Yes Yes
Cloak email addresses inside modules, 3rd party components and template overrides No Yes
Option to display email addresses as they were originally entered No Yes
Cloaking when javascript fails or is disabled No Yes
Option to ignore email addresses in feeds No Yes
Option to ignore email addresses in PDFs No Yes
Option to ignore email addresses in Javascript No Yes
Get fast support to the extension via the Support forum No Yes
 Core PluginEmail Protector
 Included in JoomlaFREE

Plugin order is important

As explained in our article dedicated to Joomla Plugin ordering, the order of plugins in your Joomla site is important.

Plugins are executed in the order they have in the Plugin Manager (under menu 'Extension' in the Joomla! administrator side).

Email Protector cloaks the email addresses that it finds at the stage it triggers. Normally, you will not run into any issue.

However if you're using 3rd party plugins to output your content, such as Articles Anywhere - and any of those articles contain email addresses you want to cloak, then you need to make sure that Email Protector is ordered after Articles Anywhere, otherwise Email Protector will be triggered before Articles Anywhere outputs the content.

Settings

Email Protector comes with a few settings, giving you control over how it works and behaves.

Here is the full list of the options you can find in the Email Protector system plugin settings, inside the Behaviour tab:

Mode Select how email addresses will be displayed.

Options: Non-linkable Text, As linkable mailto address, Leave as is
Display emails as Select how to display the emails to the viewer. This does not provide extra protection. It is only to match your visual preference.

Options: , email [AT] domain [DOT] com
Protect in feeds Select if Email Protector should replace email addresses in feeds with a custom text.
Options: No, email [AT] domain [DOT] com, Use a custom text
Feeds text The string Email Protector replaces email addresses within feeds. This can also be a language string.
Protect in PDFs Select if Email Protector should replace email addresses in PDFs with a custom text.
Options: No, email [AT] domain [DOT] com, Use a custom text
PDFs text The string Email Protector replaces email addresses within PDFs. This can also be a language string.
Protect in JSON Select if Email Protector should replace email addresses in JSON with a custom text.
Options: No, email [AT] domain [DOT] com, Use a custom text
JSON text The string Email Protector replaces email addresses within JSON. This can also be a language string.
Protect in JavaScript If selected, Email Protector will try to break up the email addresses found in inline javascript code. Disable this feature if this causes javascripts to fail.

Installation

You can either install Email Protector by using the core extension manager available in the Joomla! Administrator Control Panel, or by using the powerful Regular Labs Extension Manager.

Note: When updating Email Protector, you do not need to uninstall it first. The package will update all the files automatically.

Keep in mind that when you update to a major new version (or uninstall first), you might lose some configuration settings.

Regular Labs Extension Manager

It is very easy to install/update any Regular Labs Extension using the Regular Labs Extension Manager.

Please see the Tutorial for the Regular Labs Extension Manager for more detailed information...

Joomla! Extension Manager

To install via the Joomla! Extension Manager, just follow these steps:

  1. Log into your Joomla administrator;
  2. In the menu, choose: Extensions >> Extensions;
  3. Choose the tab: Install from Web (or enable it if you haven't done so yet);
  4. Select the search field and enter Email Protector and hit enter;
  5. Click on the Email Protector listing;
  6. Click on Install;
  7. Click on Install to confirm.
Joomla! Installer - Install from Web

Or if cannot install via the 'Install via Web' method for some reason:

  1. Download the extension install file (.zip);
  2. Log into your Joomla administrator;
  3. In the menu, choose: Extensions >> Extensions;
  4. Choose the tab: Upload Package File;
  5. Click on the Choose File button and select the extension zip;
  6. Click on Upload & Install.
Joomla! Installer - Upload Package File

If you have problems installing Email Protector, please try the manual installation process as described here: docs.joomla.org/Installing_an_extension