ac.simons.autolinker

Class EmailAddressAutoLinker

java.lang.Object

ac.simons.autolinker.EmailAddressAutoLinker

All Implemented Interfaces:

AutoLinker

public class EmailAddressAutoLinker
extends Object
implements AutoLinker

Turns valid ASCII email adresses into anchor text. The label can be obsfuscated, the email address can be encoded to hex.

Author:

Michael J. Simons, 2014-12-27

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	AT_SIGNS
static Pattern	VALID_EMAIL_ADDRESS
static Pattern	VALID_EMAIL_ADRESS_ML

Constructor Summary

Constructors

Constructor and Description
EmailAddressAutoLinker(boolean hexEncodeEmailAddress, boolean obfuscateEmailAddress) Instantiates a new email address autolinker.

Method Summary

Modifier and Type	Method and Description
List<org.jsoup.nodes.Node>	createLinks(org.jsoup.nodes.TextNode textNode) Gets the content of node and tries to find linkable content.
String	hexEncodeEmailAddress(String emailAddress) Hex encodes an email addess, leaving the '@' intact.
String	obfuscateEmailAddress(String emailAddress) Obfuscates an email address. @ will be replaced throught " [AT] " and .

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VALID_EMAIL_ADDRESS

public static final Pattern VALID_EMAIL_ADDRESS

VALID_EMAIL_ADRESS_ML

public static final Pattern VALID_EMAIL_ADRESS_ML

AT_SIGNS

public static final Pattern AT_SIGNS

Constructor Detail

EmailAddressAutoLinker

public EmailAddressAutoLinker(boolean hexEncodeEmailAddress,
                              boolean obfuscateEmailAddress)

Instantiates a new email address autolinker.

Parameters:

hexEncodeEmailAddress - Should mailto: Addresses be hex-encoded?

obfuscateEmailAddress - Should labels be obfuscated?

Method Detail

createLinks

public List<org.jsoup.nodes.Node> createLinks(org.jsoup.nodes.TextNode textNode)

Description copied from interface: AutoLinker

Gets the content of node and tries to find linkable content. If content is found, create new text nodes before and after the content and a new anchor element with the new link
If the autolinker makes no changes, just return a list containing the original node.

Specified by:

createLinks in interface AutoLinker

Parameters:

textNode - The text node which may contain linkable texts

Returns:

The new node list created from textNode

obfuscateEmailAddress

public String obfuscateEmailAddress(String emailAddress)

Obfuscates an email address. @ will be replaced throught " [AT] " and . through " [DOT] ". The email address is lowercased before processing.

Parameters:

emailAddress - The email address to obfuscate

Returns:

An obfuscated email address

hexEncodeEmailAddress

public String hexEncodeEmailAddress(String emailAddress)

Hex encodes an email addess, leaving the '@' intact. Browsers are able to decode this and maybe it's stops spammers from using emails like that. The email address is lowercased before processing.

Parameters:

emailAddress - The email address that should be encoded to hexadecimal

Returns:

An hexadecimal encoded email adresse