Awesome Open Source
Awesome Open Source

Email obfuscator plugin for Craft CMS 3.x

A simple plugin that adds a twig tag to obfuscate email addresses (by ROT13) in text fields.

Plugin Logo

Requirements

This plugin is made for Craft CMS 3.0.0-beta.23 or later. It requires the Email-Obfuscator by Propaganistas since this plugin is merely a wrapper for his Twig Extension.

Installation

To install the plugin, follow these instructions.

  1. Open your terminal and go to your Craft project:

     cd /path/to/project
    
  2. Then tell Composer to load the plugin:

     composer require lucasbares/craft-emailobfuscator
    
  3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Craft Emailobfuscator.

You can also update your craft's composer.json file and run composer update.

Using the Plugin

This plugin adds the Twig Extension made by Propaganistas to Craft. It masks all email addresses by ROT13 ciphering or CSS reverse text direction. A simple javascript file decodes the masked emails on the frontend.

To use it, just use the obfuscateEmail Twig filter on any text field or string:

{{ "Sample Text"|obfuscateEmail }}
{{ textfield|obfuscateEmail }}

Configuring the Plugin

InludeJS

By default the plugin inserts the necessary JavaScript to your front end html. There is a setting to turn this off if you want to include the JS code manually. The relevant JS code is available at https://github.com/Propaganistas/Email-Obfuscator/tree/master/assets

Credits

  • Propaganistas for developing this great Twig Extension
  • nystudio107 for providing great articles on Craft3 plugin development

Brought to you by Lucas Bares



Alternative Project Comparisons
Related Awesome Lists
Top Programming Languages
Top Projects

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Php (285,984
Plugin (113,841
Email (21,334
Cms (13,991
Mail (8,927
Twig (3,364
Craft3 (2,659
Craftcms (2,659
Obfuscator (516
Obfuscate (452
Craft Plugin (411
Twig Extension (201
Craftcms Plugin (192
Spam Protection (79
Craftcms3 (11