org.nhindirect.common.mail.dsn

Enum DSNStandard.DSNAction

java.lang.Object

java.lang.Enum<DSNStandard.DSNAction>

org.nhindirect.common.mail.dsn.DSNStandard.DSNAction

All Implemented Interfaces:

Serializable, Comparable<DSNStandard.DSNAction>

Enclosing class:

DSNStandard

public static enum DSNStandard.DSNAction
extends Enum<DSNStandard.DSNAction>

Enumeration of values for DSN action field

Since:

1.1

Author:

Greg Meyer

Enum Constant Summary

Enum Constants

Enum Constant and Description
DELAYED indicates that the Reporting MTA has so far been unable to deliver or relay the message, but it will continue to attempt to do so.
DELIVERED indicates that the message was successfully delivered to the recipient address specified by the sender, which includes "delivery" to a mailing list exploder.
EXPANDED indicates that the message has been successfully delivered to the recipient address as specified by the sender, and forwarded by the Reporting-MTA beyond that destination to multiple additional recipient addresses.
FAILED indicates that the message could not be delivered to the recipient.
RELAYED indicates that the message has been relayed or gatewayed into an environment that does not accept responsibility for generating DSNs upon successful delivery.

Method Summary

Modifier and Type	Method and Description
static DSNStandard.DSNAction	valueOf(String name) Returns the enum constant of this type with the specified name.
static DSNStandard.DSNAction[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FAILED

public static final DSNStandard.DSNAction FAILED

indicates that the message could not be delivered to the recipient. The Reporting MTA has abandoned any attempts to deliver the message to this recipient. No further notifications should be expected.

DELAYED

public static final DSNStandard.DSNAction DELAYED

indicates that the Reporting MTA has so far been unable to deliver or relay the message, but it will continue to attempt to do so. Additional notification messages may be issued as the message is further delayed or successfully delivered, or if delivery attempts are later abandoned.

DELIVERED

public static final DSNStandard.DSNAction DELIVERED

indicates that the message was successfully delivered to the recipient address specified by the sender, which includes "delivery" to a mailing list exploder. It does not indicate that the message has been read. This is a terminal state and no further DSN for this recipient should be expected.

RELAYED

public static final DSNStandard.DSNAction RELAYED

indicates that the message has been relayed or gatewayed into an environment that does not accept responsibility for generating DSNs upon successful delivery. This action-value SHOULD NOT be used unless the sender has requested notification of successful delivery for this recipient.

EXPANDED

public static final DSNStandard.DSNAction EXPANDED

indicates that the message has been successfully delivered to the recipient address as specified by the sender, and forwarded by the Reporting-MTA beyond that destination to multiple additional recipient addresses. An action-value of "expanded" differs from "delivered" in that "expanded" is not a terminal state. Further "failed" and/or "delayed" notifications may be provided.

Method Detail

values

public static DSNStandard.DSNAction[] 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 (DSNStandard.DSNAction c : DSNStandard.DSNAction.values())
    System.out.println(c);

Returns:

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

valueOf

public static DSNStandard.DSNAction 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