com.googlecode.kevinarpe.papaya.java_mail

Class EmailMessageAddress

java.lang.Object

com.googlecode.kevinarpe.papaya.java_mail.EmailMessageAddress

@FullyTested
public final class EmailMessageAddress
extends Object

Both hashCode() and equals(Object) are implemented, so these objects are safe to use with Set.

Author:

Kevin Connor ARPE (kevinarpe@gmail.com)

See Also:

JavaMailSessionBuilderFactory.INSTANCE

Field Summary

Fields

Modifier and Type	Field and Description
String	emailAddress Ex: "kevinarpe@gmail.com"
String	nullableDisplayName Never empty or all whitespace

Method Summary

Modifier and Type	Method and Description
javax.mail.internet.InternetAddress	createInternetAddress() Creates an instance of InternetAddress for use with MimeMessage.
boolean	equals(Object obj)
static EmailMessageAddress	fromEmailAddressAndDisplayName(String emailAddress, String displayName) Constructs a new email address with a display name, e.g., "First Middle LAST <username@example.com>".
static EmailMessageAddress	fromEmailAddressOnly(String emailAddress) Constructs a new email address without a display name, e.g., "username@example.com".
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

emailAddress

public final String emailAddress

Ex: "kevinarpe@gmail.com"

nullableDisplayName

@Nullable
public final String nullableDisplayName

Never empty or all whitespace

Ex: "Kevin Connor ARPE"

Method Detail

fromEmailAddressOnly

public static EmailMessageAddress fromEmailAddressOnly(String emailAddress)

Constructs a new email address without a display name, e.g., "username@example.com".

Parameters:

emailAddress - Ex: "username@example.com"
must not be empty or all whitespace

Throws:

IllegalArgumentException - if emailAddress is empty or all whitespace

See Also:

fromEmailAddressAndDisplayName(String, String), createInternetAddress()

fromEmailAddressAndDisplayName

public static EmailMessageAddress fromEmailAddressAndDisplayName(String emailAddress,
                                                                 String displayName)

Constructs a new email address with a display name, e.g., "First Middle LAST <username@example.com>".

Parameters:

emailAddress - Ex: "username@example.com"
must not be empty or all whitespace

displayName - Ex: "First Middle LAST"
must not be empty or all whitespace

Throws:

IllegalArgumentException - if emailAddress or displayName is empty or all whitespace

See Also:

fromEmailAddressAndDisplayName(String, String), createInternetAddress()

createInternetAddress

public javax.mail.internet.InternetAddress createInternetAddress()
                                                          throws Exception

Creates an instance of InternetAddress for use with MimeMessage.

Throws:

Exception - if email address is invalid or display name cannot be correctly encoded

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object