|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.mail.spi.EmailIntegrationProvider
com.jivesoftware.forum.mail.spi.DefaultIntegrationProvider
public class DefaultIntegrationProvider
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 |
---|
public DefaultIntegrationProvider()
Method Detail |
---|
public boolean canProcessMessage(javax.mail.Message message) throws javax.mail.MessagingException, java.io.IOException
EmailIntegrationProvider
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.
canProcessMessage
in class EmailIntegrationProvider
message
- the message to examine.
Message
is one which the system can do something useful with.
javax.mail.MessagingException
- if accessing the message data fails.
java.io.IOException
- if accessing the messge data fails.public EmailTokenManager getTokenManager()
EmailIntegrationProvider
EmailTokenManager
instance for reading and creating message tokens.
getTokenManager
in class EmailIntegrationProvider
EmailTokenManager
instance for reading and creating message tokens.protected EmailParser getParser(InboundMessage message) throws EmailMonitorException
EmailIntegrationProvider
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.
getParser
in class EmailIntegrationProvider
message
- the message to parse.
EmailParser
initilized with the supplied InboundMessage
.
EmailMonitorException
- if no parser can be determined, or if any access of the message contents fails.protected EmailActionBuilder getActionBuilder()
EmailIntegrationProvider
EmailActionBuilder
which can build EmailAction
instances for any email message where
calls to EmailIntegrationProvider.canProcessMessage(javax.mail.Message)
return true.
getActionBuilder
in class EmailIntegrationProvider
EmailActionBuilder
which can build EmailAction
instances for any email message where
calls to EmailIntegrationProvider.canProcessMessage(javax.mail.Message)
return true.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |