org.xwiki.mail

Enum MailState

java.lang.Object

java.lang.Enum<MailState>

org.xwiki.mail.MailState

All Implemented Interfaces:

Serializable, Comparable<MailState>

public enum MailState
extends Enum<MailState>

Represents the state of a mail (ready to be sent, sent successfully or failed to be sent).

Since:

6.4M3

Version:

$Id: b6f0bfa7353ae68b08b1a6263ce83be3375ec18f $

Enum Constant Summary

Enum Constants

Enum Constant and Description
PREPARE_ERROR Error was encountered during mail preparation, no message available for sending.
PREPARE_SUCCESS Mail prepared successfully and ready to be sent.
SEND_ERROR Error was encountered during sending mail.
SEND_FATAL_ERROR Error was encountered while retrieving mail for sending.
SEND_SUCCESS Mail sent with success.

Method Summary

Modifier and Type	Method and Description
static MailState	parse(String state) Create a MailState object from a String.
String	toString()
static MailState	valueOf(String name) Returns the enum constant of this type with the specified name.
static MailState[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PREPARE_SUCCESS

public static final MailState PREPARE_SUCCESS

Mail prepared successfully and ready to be sent.

Since:

7.1RC1

PREPARE_ERROR

public static final MailState PREPARE_ERROR

Error was encountered during mail preparation, no message available for sending.

Since:

7.1RC1

SEND_SUCCESS

public static final MailState SEND_SUCCESS

Mail sent with success.

Since:

7.1RC1

SEND_ERROR

public static final MailState SEND_ERROR

Error was encountered during sending mail.

Since:

7.1RC1

SEND_FATAL_ERROR

public static final MailState SEND_FATAL_ERROR

Error was encountered while retrieving mail for sending.

Since:

7.1RC1

Method Detail

values

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

Returns:

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

valueOf

public static MailState 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

toString

public String toString()

Overrides:

toString in class Enum<MailState>

Returns:

the lower case String version of the enum, to use lowercase String on database

parse

public static MailState parse(String state)

Create a MailState object from a String.

Parameters:

state - the state represented as a string

Returns:

the MailState object

Throws:

IllegalArgumentException - if the passed stated is invalid