ejel
Enum EventManager.EventID

java.lang.Object
  java.lang.Enum<EventManager.EventID>
      ejel.EventManager.EventID

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EventManager.EventID>

Enclosing class:

EventManager

public static enum EventManager.EventID
extends java.lang.Enum<EventManager.EventID>

Event IDs for JavaEmailer Sender engine

Enum Constant Summary

EID_ABORTED
The ID of the event that is raised when the external code oreders the sender engine to abort the mass mail operation.

EID_EMAIL_ACCOUNT_NEEDED
The ID of the event that is raised when all of the email accounts are disabled and the sender engine needs a new one to continue the mass mail operation.

EID_EXCEPTION
The ID of the event that is raised when an exception occures while sending an email.

EID_FINISHED
The ID of the event that is raised when the sender engine is totally finished.

EID_FINISHING
The ID of the event that is raised when the sender engine is about to finish the mass mail operation.

EID_NEXT_INBOX_EMAIL
The ID of the event that is raised when the InboxEmailsReader async iterator find an email message that matches the search query.

EID_PAUSED
The ID of the event that is raised when the sender engine is fully paused

EID_PAUSING
The ID of the event that is raised when an external code order the the sender engine to switch to Pause mode.

EID_RESUMED
The ID of the event that is raised when the external code orders the sender engine to resume the mass mailing operation when it's paused.

EID_SENDING
The ID of the event that is raised when the sender engine is about to send an email.

EID_SENT
The ID of the event that is raised when an email is sent successfully

EID_STARTED
The ID of the event that is raised when the sender engine starts

Method Summary

static EventManager.EventID	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EventManager.EventID[]	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

EID_STARTED

public static final EventManager.EventID EID_STARTED

The ID of the event that is raised when the sender engine starts

EID_PAUSING

public static final EventManager.EventID EID_PAUSING

The ID of the event that is raised when an external code order the the sender engine to switch to Pause mode. The sender engine raises that event, wait till all senders thread terminates their current send operations and then switch to Pause mode. The external code can cancel the pause switch by setting CancelEventArgs.cancel to true.

EID_PAUSED

public static final EventManager.EventID EID_PAUSED

The ID of the event that is raised when the sender engine is fully paused

EID_RESUMED

public static final EventManager.EventID EID_RESUMED

The ID of the event that is raised when the external code orders the sender engine to resume the mass mailing operation when it's paused.

EID_SENDING

public static final EventManager.EventID EID_SENDING

The ID of the event that is raised when the sender engine is about to send an email. The external code can here alter/customize the original email content.

EID_SENT

public static final EventManager.EventID EID_SENT

The ID of the event that is raised when an email is sent successfully

EID_FINISHING

public static final EventManager.EventID EID_FINISHING

The ID of the event that is raised when the sender engine is about to finish the mass mail operation. It sends that event and wait for sender threads to terminate their send operations then it sends the finish event.

EID_FINISHED

public static final EventManager.EventID EID_FINISHED

The ID of the event that is raised when the sender engine is totally finished.

EID_EXCEPTION

public static final EventManager.EventID EID_EXCEPTION

The ID of the event that is raised when an exception occures while sending an email. Here, you can disable the email account which caused the fail exception, you can order the sender engine to send again the same email using an other email account or ignore the failed send operation and resume to next one.

EID_ABORTED

public static final EventManager.EventID EID_ABORTED

The ID of the event that is raised when the external code oreders the sender engine to abort the mass mail operation.

EID_EMAIL_ACCOUNT_NEEDED

public static final EventManager.EventID EID_EMAIL_ACCOUNT_NEEDED

The ID of the event that is raised when all of the email accounts are disabled and the sender engine needs a new one to continue the mass mail operation. The external code can provide a new one if possible or the sender engine will abort the mass mailing operation.

EID_NEXT_INBOX_EMAIL

public static final EventManager.EventID EID_NEXT_INBOX_EMAIL

The ID of the event that is raised when the InboxEmailsReader async iterator find an email message that matches the search query. During that event, the external code can check the inbox of an email account used to send mass mailing to find for example undelivered emails and mark them so as not to waste time sending further emails to it during next mass mailing operations.

See Also:

InboxEmailsReader

Method Detail

values

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

Returns:

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

valueOf

public static EventManager.EventID valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null