Skip to content

README.md

Latest commit

 

History

History
76 lines (46 loc) · 2.74 KB

README.md

File metadata and controls

76 lines (46 loc) · 2.74 KB
Raw

Email Address Obfuscation Edited

Icon

Description

A fork of the Publii Team's Email Address Obfuscation plugin (https://marketplace.getpublii.com/plugins/email-address-obfuscation/), adding a per-build randomised wrapper class, generic data-* attributes, mailto click handlers instead of exposed hrefs, and optional decoy DOM fragments.

Hides email addresses in your generated site from spambots and scrapers.

Emails and mailto: links are rewritten at build time and restored for real visitors by a small frontend script.

Features

  • Fragment (recommended): email chunked and encoded, cipher and attribute names randomised on every build, decoys mixed in.
  • Reverse, ROT18, Replace with Text: the original plugin's methods, unchanged.
  • Obfuscate all emails, or only a specific list.
  • Emails stripped from the page <head>.

Additional hardening for the Fragment method is included: click-to-reveal gate, real-input requirement, headless-browser detection, honeypot trap email, decoy fragments, randomised class name.

Each is explained in the plugin settings.

Requirements

Publii 0.44.0 or newer.

Installation

  1. Download the release ZIP.
  2. Publii -> Tools -> Plugins -> Install plugin -> pick the ZIP.
  3. Enable the plugin for the site.

Usage

Open Plugins -> Email Address Obfuscation Edited -> settings icon.

  • Global Email Obfuscation: on: obfuscate all emails; off: reveals the Emails to Obfuscate field.
  • Emails to Obfuscate: one address per line; only these are obfuscated.
  • Obfuscation Method: Reverse, ROT18, or Replace with Text.
  • Replacement for @ / Replacement for .: text used by the Replace method.
  • Enable Decoy Fragments: ROT18 only; interleaves hidden decoy characters into the decoded email.

Save, then preview or render the site.

screenshot

Contributing

For the Tidy Customs / Publii team, feel free to take fold this fork back into the original plugin.

Feel free to fork this project or contribute a PR.

Build instructions can be found in the developer readme DEV.md.

Licenses

Main code

This project is licensed under the GPLv3+ as the original module. See LICENSE file for details.

Credits

Forked from the Publii Team's "Email Address Obfuscation" plugin (https://marketplace.getpublii.com/plugins/email-address-obfuscation/), thanks to the Publii project for the original plugin, the CMS, and its plugin API.

This project was developed by InPoint Automation Sp. z o.o. https://inpointautomation.com/

Changelog

See CHANGELOG.md for the full version history.