create new tag
, view all tags


Obfuscates e-mail addresses by characters to their HTML character entity references


This plugin replaces characters in email address with their appropriate HTML entity references. This is intended to help prevent email harvesters from recognizing addresses.

Syntax Rules

  • N/A


  • user@example.com (If you view source you should see that the string is encoded).

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %EMAILOBFUSCATIONPLUGIN_SHORTDESCRIPTION%

  • Short description:
    • Set SHORTDESCRIPTION = Obfuscates e-mail addresses by characters to their HTML character entity references

  • Debug plugin: (See output in data/debug.txt)
    • Set DEBUG = 0

  • Range of characters to encode (NOTE: Setting a bad range here can result in your TWiki not displaying content, please ensure that a correct range is used and that the Plugin topic is locked to TWikiAdminGroup):
    • Set ESCAPELIST = \000-\056\072-\100\133-\140\173-\177

  • Restrict access: (remove the # to enable the access control)

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

  • Ensure you have the HTML::Entities module installed from CPAN.
  • Download the ZIP file from the Plugin web (see below)
  • Unzip EmailObfuscationPlugin.zip in your twiki installation directory. Content:
File: Description:
data/TWiki/EmailObfuscationPlugin.txt Plugin topic
lib/TWiki/Plugins/EmailObfuscationPlugin.pm Plugin Perl module
  • Configure the Plugin:
    • Run the configure script to enable the plugin
    • Change the plugin settings as needed. Enable the access control by removing the # from the Set ALLOWTOPICCHANGE

Plugin Info

Plugin Author: TWiki:Main.StephenGordon
Copyright: © 2006, TWiki:Main.StephenGordon
© 2006-2010 TWiki:TWiki.TWikiContributor
License: GPL (GNU General Public License External link mark)
Plugin Version: 2010-10-30 (V1.001)
Change History:  
2010-10-30: TWikibug:Item6530: Doc fixes
2006-05-17: Initial version
TWiki Dependency: $TWiki::Plugins::VERSION 1.1
CPAN Dependencies: CPAN:HTML::Entities
Other Dependencies: none
Perl Version: 5.005
Benchmarks: GoodStyle 98%, FormattedSearch 99%, EmailObfuscationPlugin 98%
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/EmailObfuscationPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/EmailObfuscationPluginDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/EmailObfuscationPluginAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

Topic revision: r3 - 2013-06-04 - TWikiAdminUser

This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2022 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.EmailObfuscationPlugin.