jodd.mail

Class RFC2822AddressParser

java.lang.Object

jodd.mail.RFC2822AddressParser

public class RFC2822AddressParser
extends java.lang.Object

Utility class to parse, clean up, and extract email addresses per RFC2822 syntax. It can be trusted to only provide authenticated results. This class has been successfully used on many billion real-world addresses, live in production environments, but it's not perfect yet, since the standard is quite complex.

Note: Unlike InternetAddress, this class will preserve any RFC-2047-encoding of international characters.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RFC2822AddressParser.ParsedAddress Parsed message address and various information.

Field Summary

Fields

Modifier and Type	Field and Description
static RFC2822AddressParser	LOOSE Loose parser.
static RFC2822AddressParser	STRICT Strict parser.

Constructor Summary

Constructors

Constructor and Description
RFC2822AddressParser()

Method Summary

Modifier and Type	Method and Description
RFC2822AddressParser	allowDomainLiterals(boolean allow) Changes the behavior of the domain parsing.
RFC2822AddressParser	allowDotInAtext(boolean allow) Allows ".
RFC2822AddressParser	allowParentheseInLocalpart(boolean allow) Allows ")" or "(" to appear in quoted versions of the localpart (they are never allowed in unquoted versions).
RFC2822AddressParser	allowQuotedIdentifiers(boolean allow) Defines if quoted identifiers are allowed.
RFC2822AddressParser	allowSquareBracketsInAtext(boolean allow) Allows "[" or "]" to appear in atext.
RFC2822AddressParser	extractCfwsPersonalName(boolean extract) Controls the behavior of getInternetAddress.
RFC2822AddressParser.ParsedAddress	parse(java.lang.String email) Parses email address.
EmailAddress	parseToEmailAddress(java.lang.String email) Convenient shortcut of parse(String) that returns EmailAddress or null.
javax.mail.internet.InternetAddress	parseToInternetAddress(java.lang.String email) Convenient shortcut of parse(String) that returns InternetAddress or null.

Methods inherited from class java.lang.Object

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

Field Detail

STRICT

public static final RFC2822AddressParser STRICT

Strict parser.

LOOSE

public static final RFC2822AddressParser LOOSE

Loose parser.

Constructor Detail

RFC2822AddressParser

public RFC2822AddressParser()

Method Detail

allowDomainLiterals

public RFC2822AddressParser allowDomainLiterals(boolean allow)

Changes the behavior of the domain parsing. If true, the parser will allow 2822 domains, which include single-level domains (e.g. bob@localhost) as well as domain literals, 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 many 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), and specifically only those with at least two levels ("example.com"), then set this flag to false.

allowQuotedIdentifiers

public RFC2822AddressParser allowQuotedIdentifiers(boolean allow)

Defines if quoted identifiers are allowed. Using quotes and angle brackets around the raw address may be 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 the flag false.

allowDotInAtext

public RFC2822AddressParser allowDotInAtext(boolean allow)

Allows "." to appear in atext (note: only atext which appears in the 2822 "name-addr" part of the address, not the other instances).

The addresses:

• Kayaks.org <kayaks@kayaks.org>
• Bob K. Smith<bobksmith@bob.net>

...are not valid. They should be:

• "Kayaks.org" <kayaks@kayaks.org>
• "Bob K. Smith" <bobksmith@bob.net>

If this boolean is set to false, the parser will act per 2822 and will require the quotes; if set to true, it will allow the use of "." without quotes.

extractCfwsPersonalName

public RFC2822AddressParser extractCfwsPersonalName(boolean extract)

Controls the behavior of getInternetAddress. If true, allows the real world practice of:

• <bob@example.com> (Bob Smith)

In this case, "Bob Smith" is not technically the personal name, just a comment. If this is set to true, the methods will convert this into:

• Bob Smith <bob@example.com>

This also happens somewhat more often and appropriately with mailer-daemon@blah.com (Mail Delivery System).

If a personal name appears to the left and CFWS appears to the right of an address, the methods will favor the personal name to the left. If the methods need to use the CFWS following the address, they will take the first comment token they find.

allowSquareBracketsInAtext

public RFC2822AddressParser allowSquareBracketsInAtext(boolean allow)

Allows "[" or "]" to appear in atext. The address:

• [Kayaks] <kayaks@kayaks.org>

...is not valid. It should be:

• "[Kayaks]" <kayaks@kayaks.org>

If this boolean is set to false, the parser will act per 2822 and will require the quotes; if set to true, it will allow them to be missing.

Use at your own risk. There may be some issue with enabling this feature in conjunction with allowDomainLiterals(boolean).

allowParentheseInLocalpart

public RFC2822AddressParser allowParentheseInLocalpart(boolean allow)

Allows ")" or "(" to appear in quoted versions of the localpart (they are never allowed in unquoted versions). The default (2822) behavior is to allow this, i.e. boolean true. You can disallow it, but better to leave it true.

parse

public RFC2822AddressParser.ParsedAddress parse(java.lang.String email)

Parses email address. Returns parsed address, that might be valid or not.

parseToInternetAddress

public javax.mail.internet.InternetAddress parseToInternetAddress(java.lang.String email)

Convenient shortcut of parse(String) that returns InternetAddress or null.

parseToEmailAddress

public EmailAddress parseToEmailAddress(java.lang.String email)

Convenient shortcut of parse(String) that returns EmailAddress or null.