EmailObfuscationPlugin

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

Syntax Rules

• N/A

Examples

• 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. %NEWPLUGIN_SHORTDESCRIPTION%

• Set SHORTDESCRIPTION = Obstuficates 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

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
  data/TWiki/EmailObfuscationPlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/EmailObfuscationPlugin.pm	Plugin Perl module

• Configure the Plugin:
  • TWiki 4.0 and up: Run the configure script to enable the Plugin
  • Change the Plugin settings as needed

Plugin Info

Plugin Author:	TWiki:Main.StephenGordon
Copyright:	© 2006, TWiki:Main.StephenGordon
License:	GPL (GNU General Public License)
Plugin Version:	2012-02-12 (V1.000)
Change History:
2012-02-12:	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.1
CPAN Dependencies:	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

-- TWiki:Main.guest - 2012-02-12

• Set ALLOWTOPICCHANGE = TWikiAdminGroup