Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.mail
Class EmailMonitorException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.jivesoftware.base.JiveException
              extended by com.jivesoftware.forum.mail.EmailMonitorException
All Implemented Interfaces:
java.io.Serializable

public class EmailMonitorException
extends JiveException

Exception thrown by the email monitoring system. In general, throwing this exception inside classes of the containing package will result in the sending of rejection emails to whomever the system was acting on behalf of when the exception occurred. To behave correctly, at a minimum the methods setRejectedUserID(long) and setRejectionReasonProperty(java.lang.String) should be called. The user id is the id of the user who will be emailed, and the rejection reason property is a key in the forums resource bundle that corresponds to a localized string explaining what happened and what (if anything) the user can do about it.

See Also:
Serialized Form

Constructor Summary
EmailMonitorException()
           
EmailMonitorException(java.lang.String message)
           
EmailMonitorException(java.lang.String message, java.lang.Throwable cause)
           
EmailMonitorException(java.lang.Throwable cause)
           
 
Method Summary
 long getRejectedUserID()
           
 java.lang.String getRejectionMailAddress()
           
 java.lang.String getRejectionReasonProperty()
           
 void setRejectedUserID(long userID)
           
 void setRejectionMailAddress(java.lang.String rejectionMailAddress)
           
 void setRejectionReasonProperty(java.lang.String reasonProperty)
           
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

EmailMonitorException

public EmailMonitorException()

EmailMonitorException

public EmailMonitorException(java.lang.String message,
                             java.lang.Throwable cause)

EmailMonitorException

public EmailMonitorException(java.lang.String message)

EmailMonitorException

public EmailMonitorException(java.lang.Throwable cause)
Method Detail

setRejectionMailAddress

public void setRejectionMailAddress(java.lang.String rejectionMailAddress)

getRejectionMailAddress

public java.lang.String getRejectionMailAddress()

getRejectedUserID

public long getRejectedUserID()

setRejectedUserID

public void setRejectedUserID(long userID)

getRejectionReasonProperty

public java.lang.String getRejectionReasonProperty()

setRejectionReasonProperty

public void setRejectionReasonProperty(java.lang.String reasonProperty)

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.