Jive Forums API (5.5.20.2-oracle) Core Javadocs

com.jivesoftware.base
Class EmailManager

java.lang.Object
  extended by com.jivesoftware.base.EmailManager
All Implemented Interfaces:
com.jivesoftware.base.JiveManager

public class EmailManager
extends java.lang.Object
implements com.jivesoftware.base.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()
           
 void drainEmailQueue(java.util.List messagesToPopulate)
           
static EmailManager getEmailManager()
          Used to acquire an instance of EmailManager.
 void initialize()
           
 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()
Specified by:
initialize in interface com.jivesoftware.base.JiveManager

destroy

public void destroy()
Specified by:
destroy in interface com.jivesoftware.base.JiveManager

drainEmailQueue

public void drainEmailQueue(java.util.List messagesToPopulate)

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.