|
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.EmailParserImpl
public class EmailParserImpl
Default implementation of EmailParser
which relies on the presence of a
special token in the email subject which contains data used for user authentication an message routing when reading
replies to watch notification email replies.
Constructor Summary | |
---|---|
EmailParserImpl(EmailTokenManager emailTokenManager)
Sole constructor which takes an EmailTokenManager to read incoming mail tokens. |
Method Summary | |
---|---|
java.lang.String |
getBody()
Returns the body of the message |
long |
getObjectID()
Returns the id of the object to act on. |
int |
getObjectType()
Returns the object type (Forum, Message, etc) to act on. |
java.lang.String |
getSubject()
Returns the subject of the message |
long |
getUserID()
Returns the user id of the sender |
void |
parse(InboundMessage message)
Parses the contents of the supplied Message and uses it to populate all the properties
exposed by this object. |
boolean |
parseCompleted()
Returns true if parse(com.jivesoftware.forum.mail.InboundMessage) has been called and successfully completed. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public EmailParserImpl(EmailTokenManager emailTokenManager)
EmailTokenManager
to read incoming mail tokens.
emailTokenManager
- an EmailTokenManager
to read incoming mail tokens.Method Detail |
---|
public long getUserID()
getUserID
in interface EmailParser
public int getObjectType()
getObjectType
in interface EmailParser
public long getObjectID()
getObjectID
in interface EmailParser
public java.lang.String getSubject()
getSubject
in interface EmailParser
public java.lang.String getBody()
getBody
in interface EmailParser
public boolean parseCompleted()
parse(com.jivesoftware.forum.mail.InboundMessage)
has been called and successfully completed.
parseCompleted
in interface EmailParser
parse(com.jivesoftware.forum.mail.InboundMessage)
has been called and successfully completed.public void parse(InboundMessage message) throws EmailMonitorException
Message
and uses it to populate all the properties
exposed by this object.
parse
in interface EmailParser
message
- the InboundMessage
to parse.
EmailMonitorException
- if parsing fails for any reason.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |