com.intercognition.mailcheck

Class MailCheck

java.lang.Object

com.intercognition.mailcheck.MailCheck

public class MailCheck
extends Object

Usage:

First construct with a configuration. A default configuration is supplied to get you started quickly:

MailCheck mailCheck = new MailCheck(new DefaultConfiguration());

Then use the MailCheck object to give you suggestions:

EmailAddress suggestion = mailCheck.suggest("test@hitmail.com");

If the returned object is null

Constructor Summary

Constructors

Constructor and Description
MailCheck(Configuration configuration) Creates a new MailCheck instance with the given configuration.

Method Summary

Modifier and Type	Method and Description
protected String	findClosestString(String candidate, Collection<String> possibleMatches, DistanceAlgorithm distanceAlgorithm, int threshold)
EmailAddress	suggest(String email)

Methods inherited from class java.lang.Object

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

Constructor Detail

MailCheck

public MailCheck(Configuration configuration)

Creates a new MailCheck instance with the given configuration.

Parameters:

configuration - The desired configuration.

Method Detail

suggest

public EmailAddress suggest(String email)

Parameters:

email - The user entered email address that you want to check for suggestions with

Returns:

null, if no suggestions, or an EmailAddress object containing the suggestion

findClosestString

protected String findClosestString(String candidate,
                                   Collection<String> possibleMatches,
                                   DistanceAlgorithm distanceAlgorithm,
                                   int threshold)