|
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 |
public interface EmailParser
Parses the contents of a Message
object in order to provide data used by the system to execute actions
based on incoming email. This parser is a one-shot object, designed to be created and used per email message. Used by
EmailMonitor
to access information in the mail it reads.
EmailMonitor
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 one of the values in JiveConstants specifiying what type
of object to act on. |
java.lang.String |
getSubject()
Returns the subject of the message |
long |
getUserID()
Returns the user id of the user on whose befalf the system will act. |
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. |
Method Detail |
---|
long getUserID()
int getObjectType()
JiveConstants
specifiying what type
of object to act on.
JiveConstants
specifiying what type
of object to act on.long getObjectID()
java.lang.String getSubject()
java.lang.String getBody()
boolean parseCompleted()
parse(com.jivesoftware.forum.mail.InboundMessage)
has been called and successfully completed.
parse(com.jivesoftware.forum.mail.InboundMessage)
has been called and successfully completed.void parse(InboundMessage message) throws EmailMonitorException
Message
and uses it to populate all the properties
exposed by this object.
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 |