com.googlecode.kevinarpe.papaya.java_mail

Enum EmailMessageAddressType

java.lang.Object

java.lang.Enum<EmailMessageAddressType>

com.googlecode.kevinarpe.papaya.java_mail.EmailMessageAddressType

All Implemented Interfaces:

Serializable, Comparable<EmailMessageAddressType>

@FullyTested
public enum EmailMessageAddressType
extends Enum<EmailMessageAddressType>

Author:

Kevin Connor ARPE (kevinarpe@gmail.com)

See Also:

JavaMailSessionBuilderFactory.INSTANCE

Enum Constant Summary

Enum Constants

Enum Constant and Description
FROM Required: The from address of an email message.
SENDER Optional: The sender address when 'sent-on-behalf'.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	isRequired

Method Summary

Modifier and Type	Method and Description
abstract void	setValue(javax.mail.internet.MimeMessage m, javax.mail.internet.InternetAddress inetAddr)
static EmailMessageAddressType	valueOf(String name) Returns the enum constant of this type with the specified name.
static EmailMessageAddressType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FROM

public static final EmailMessageAddressType FROM

Required: The from address of an email message.

See Also:

MimeMessage.setFrom(Address)

SENDER

public static final EmailMessageAddressType SENDER

Optional: The sender address when 'sent-on-behalf'. This is used when assistants send email on behalf of another person.

See Also:

MimeMessage.setSender(Address)

Field Detail

isRequired

public final boolean isRequired

Method Detail

values

public static EmailMessageAddressType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EmailMessageAddressType c : EmailMessageAddressType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EmailMessageAddressType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

setValue

public abstract void setValue(javax.mail.internet.MimeMessage m,
                              javax.mail.internet.InternetAddress inetAddr)
                       throws Exception

Throws:

Exception