com.jivesoftware.base
Class EmailManager

java.lang.Object
  com.jivesoftware.base.EmailManager

All Implemented Interfaces:

JiveManager

public class EmailManager
extends java.lang.Object
implements JiveManager

Provides ability to send email messages.

Instacnes of this class can be acquired via the factory method getEmailManager()

Since:

5.0

See Also:

EmailMessage

Method Summary

void	destroy() Notifies the manager to release any resources that may be holding on too.
void	drainEmailQueue(java.util.List messagesToPopulate)
static EmailManager	getEmailManager() Used to acquire an instance of EmailManager.
void	initialize() Initialize the manager.
void	send(EmailMessage message) Used to send an email message.

Methods inherited from class java.lang.Object

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

Method Detail

send

public void send(EmailMessage message)

Used to send an email message. This will add the email message to an outbound email message queue that will be processed by the first available worker.

Parameters:

message - message to be sent

getEmailManager

public static EmailManager getEmailManager()

Used to acquire an instance of EmailManager.

Returns:

Returns an instance of EmailManager

initialize

public void initialize()

Description copied from interface: JiveManager

Initialize the manager. It is within this method that it is ok to create, access and/or otherwise use external classes (including caches). Until this method is called implementation should not access any external classes that could possibly either access one of the main Factory classes or any caches since doing so can cause deadlocks and possible clustering issues during startup.

This method is used internally by Jive during application startup and should not be called during normal usage of the class.

Specified by:

initialize in interface JiveManager

destroy

public void destroy()

Description copied from interface: JiveManager

Notifies the manager to release any resources that may be holding on too. This could also be used to clear out the managers caches, etc.

This method is used internally by Jive during application startup and should not be called during normal usage of the class.

Specified by:

destroy in interface JiveManager

drainEmailQueue

public void drainEmailQueue(java.util.List messagesToPopulate)