er.extensions.net

Class ERXEmailValidator

java.lang.Object

er.extensions.net.ERXEmailValidator

All Implemented Interfaces:

Serializable

public final class ERXEmailValidator
extends Object
implements Serializable

Email validation class inspired by Les Hazlewood's email validator. This class is immutable and thread safe.

See Also:

Serialized Form

Author:

Les Hazlewood (regular expressions), Ramsey Gurley (threaded domain validation)

Constructor Summary

Constructors

Constructor and Description
ERXEmailValidator(boolean allowQuotedIdentifiers, boolean allowDomainLiterals)

Method Summary

Modifier and Type	Method and Description
static String	hostNameForEmailString(String email) Parses the host name from the email string
static Boolean	isValidDomainString(String hostName, long timeout) Deprecated. this method will throw mysterious NullPointerExceptions if used in a loop. Evidently, something about the DirContext is not as thread safe as the javadocs claim. Do not use it.
boolean	isValidEmailAddress(String email, long timeout, boolean def) Deprecated. Deprecated because it relies on isValidDomainString(String, long)
boolean	isValidEmailString(String email) Utility method that checks to see if the specified string is a valid email address according to the * RFC 2822 specification.

Methods inherited from class java.lang.Object

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

Constructor Detail

ERXEmailValidator

public ERXEmailValidator(boolean allowQuotedIdentifiers,
                         boolean allowDomainLiterals)

Parameters:

allowQuotedIdentifiers - if true, quoted identifiers are allowed (using quotes and angle brackets around the raw address) are allowed, e.g.: "John Smith" <john.smith@somewhere.com> The RFC says this is a valid mailbox. If you don't want to allow this, because for example, you only want users to enter in a raw address (john.smith@somewhere.com - no quotes or angle brackets), then set this to false.

allowDomainLiterals - if true, domain literals are allowed in the email address, e.g.: someone@[192.168.1.100] or john.doe@[23:33:A2:22:16:1F] or me@[my computer] The RFC says these are valid email addresses, but most people don't like allowing them. If you don't want to allow them, and only want to allow valid domain names (RFC 1035, x.y.z.com, etc), set this to false.

Method Detail

isValidEmailString

public boolean isValidEmailString(String email)

Utility method that checks to see if the specified string is a valid email address according to the * RFC 2822 specification.

Parameters:

email - the email address string to test for validity.

Returns:

true if the given text valid according to RFC 2822, false otherwise.

isValidDomainString

public static Boolean isValidDomainString(String hostName,
                                          long timeout)

Deprecated. this method will throw mysterious NullPointerExceptions if used in a loop. Evidently, something about the DirContext is not as thread safe as the javadocs claim. Do not use it.

Checks to see if the hostName is a valid email domain. A timeout is specified which limits the time spent waiting for the DNS lookup. If the timeout is exceeded, the method returns null.

Parameters:

hostName - the email hostName

timeout - the timeout in milliseconds

Returns:

true if the hostName is valid, false if no hostName or MX record is found, null if lookup times out

Throws:

NamingException

isValidEmailAddress

public boolean isValidEmailAddress(String email,
                                   long timeout,
                                   boolean def)

Deprecated. Deprecated because it relies on isValidDomainString(String, long)

Convenience method to validate email address string and domain. If a timeout occurs, the default boolean value is returned.

Parameters:

email - the email string to test

timeout - the timeout in milliseconds

def - default value if timeout occurs

Returns:

true if the email passes both validations

hostNameForEmailString

public static String hostNameForEmailString(String email)

Parses the host name from the email string

Parameters:

email - the email address

Returns:

the hostName portion of the email address