Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.mail.spi
Class DefaultIntegrationProvider

java.lang.Object
  extended by com.jivesoftware.forum.mail.spi.EmailIntegrationProvider
      extended by com.jivesoftware.forum.mail.spi.DefaultIntegrationProvider

public class DefaultIntegrationProvider
extends EmailIntegrationProvider

Default implementation of EmailIntegrationProvider which can respond to watch notification email replies.


Constructor Summary
DefaultIntegrationProvider()
           
 
Method Summary
 boolean canProcessMessage(javax.mail.Message message)
          Returns true if the supplied Message is one which the system can do something useful with.
protected  EmailActionBuilder getActionBuilder()
          Returns an EmailActionBuilder which can build EmailAction instances for any email message where calls to EmailIntegrationProvider.canProcessMessage(javax.mail.Message) return true.
protected  EmailParser getParser(InboundMessage message)
          Returns an EmailParser initilized with the supplied InboundMessage.
 EmailTokenManager getTokenManager()
          Returns an EmailTokenManager instance for reading and creating message tokens.
 
Methods inherited from class com.jivesoftware.forum.mail.spi.EmailIntegrationProvider
getActionForMessage
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultIntegrationProvider

public DefaultIntegrationProvider()
Method Detail

canProcessMessage

public boolean canProcessMessage(javax.mail.Message message)
                          throws javax.mail.MessagingException,
                                 java.io.IOException
Description copied from class: EmailIntegrationProvider
Returns true if the supplied Message is one which the system can do something useful with. In general, the contents of the subject and any other headers are examined for patterns which indicate it is really intended for forums to deal with and not junk mail.

Specified by:
canProcessMessage in class EmailIntegrationProvider
Parameters:
message - the message to examine.
Returns:
true if the supplied Message is one which the system can do something useful with.
Throws:
javax.mail.MessagingException - if accessing the message data fails.
java.io.IOException - if accessing the messge data fails.

getTokenManager

public EmailTokenManager getTokenManager()
Description copied from class: EmailIntegrationProvider
Returns an EmailTokenManager instance for reading and creating message tokens.

Specified by:
getTokenManager in class EmailIntegrationProvider
Returns:
an EmailTokenManager instance for reading and creating message tokens.

getParser

protected EmailParser getParser(InboundMessage message)
                         throws EmailMonitorException
Description copied from class: EmailIntegrationProvider
Returns an EmailParser initilized with the supplied InboundMessage. Calling EmailParser.parse(com.jivesoftware.forum.mail.InboundMessage) will parse the message and make its relevant contents available through accessor properties of the parser instance.

Specified by:
getParser in class EmailIntegrationProvider
Parameters:
message - the message to parse.
Returns:
an EmailParser initilized with the supplied InboundMessage.
Throws:
EmailMonitorException - if no parser can be determined, or if any access of the message contents fails.

getActionBuilder

protected EmailActionBuilder getActionBuilder()
Description copied from class: EmailIntegrationProvider
Returns an EmailActionBuilder which can build EmailAction instances for any email message where calls to EmailIntegrationProvider.canProcessMessage(javax.mail.Message) return true.

Specified by:
getActionBuilder in class EmailIntegrationProvider
Returns:
an EmailActionBuilder which can build EmailAction instances for any email message where calls to EmailIntegrationProvider.canProcessMessage(javax.mail.Message) return true.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.