com.jivesoftware.community.event
Class EmailEvent

java.lang.Object
  com.jivesoftware.community.event.EmailEvent

All Implemented Interfaces:

com.jivesoftware.community.JiveEvent

public class EmailEvent
extends Object
implements com.jivesoftware.community.JiveEvent

A class for EmailEvent events. This class will be passed to EmailListeners whenever an email event is fired and contains all the pertinent information to the event.

Field Summary

static int	EMAIL_RECEIVED An email was received.
static int	EMAIL_SENDING An email is about to be sent.

Constructor Summary

EmailEvent(int eventType, Message message, EmailMessage emailMessage, Map<String,? extends Object> params)
Creates a new email event.

Method Summary

Date	getDate()
EmailMessage	getEmailMessage() Returns the Clearspace email message that this email wraps.
int	getEventType()
Message	getMessage() Returns the Message that the event corresponds to.
Map<String,? extends Object>	getParams()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMAIL_SENDING

public static final int EMAIL_SENDING

An email is about to be sent.

See Also:

Constant Field Values

EMAIL_RECEIVED

public static final int EMAIL_RECEIVED

An email was received.

See Also:

Constant Field Values

Constructor Detail

EmailEvent

public EmailEvent(int eventType,
                  Message message,
                  EmailMessage emailMessage,
                  Map<String,? extends Object> params)

Creates a new email event.

Parameters:

eventType - the type of the email event.

message - the smtp message envelope the event corresponds to.

emailMessage - the Clearspace email message

params - parameters corresponding to the event.

Method Detail

getEventType

public int getEventType()

Specified by:

getEventType in interface com.jivesoftware.community.JiveEvent

getMessage

public Message getMessage()

Returns the Message that the event corresponds to.

Returns:

the message the event corresponds to.

getEmailMessage

public EmailMessage getEmailMessage()

Returns the Clearspace email message that this email wraps.

Returns:

the Clearspace email message that this email wraps.

getParams

public Map<String,? extends Object> getParams()

Specified by:

getParams in interface com.jivesoftware.community.JiveEvent

getDate

public Date getDate()

Specified by:

getDate in interface com.jivesoftware.community.JiveEvent