com.jivesoftware.forum.mail
Interface InboundMessage

All Known Implementing Classes:

IMAPMessage, POP3Message

public interface InboundMessage

Simplified view of an email message which allows access only to message elements needed by the system.

Method Summary

java.util.Iterator	getAttachments() Returns the attachments as an Iterator of AttachmentData.
java.lang.String	getBody() Returns the body text of the message.
javax.mail.Address[]	getFrom() Returns the sender addresses.
java.lang.String[]	getHeader(java.lang.String headerName) Returns the header values corresponding to the supplied header name.
java.util.Iterator	getHeaders() Returns the headers sent with the message as an Iterator of strings.
java.lang.String	getSubject() Returns the subject text of the message.

Method Detail

getSubject

java.lang.String getSubject()
                            throws javax.mail.MessagingException

Returns the subject text of the message.

Returns:

the subject text of the message.

Throws:

javax.mail.MessagingException - if a server communication error occurs.

getBody

java.lang.String getBody()
                         throws javax.mail.MessagingException,
                                java.io.IOException,
                                EmailMonitorException

Returns the body text of the message.

Returns:

the body text of the message.

Throws:

javax.mail.MessagingException - if a server communication error occurs.

java.io.IOException - if a server communication error occurs.

EmailMonitorException - if the body is an unhandled content type.

getFrom

javax.mail.Address[] getFrom()
                             throws javax.mail.MessagingException

Returns the sender addresses.

Returns:

the sender addresses.

Throws:

javax.mail.MessagingException - if a server communication error occurs.

getAttachments

java.util.Iterator getAttachments()
                                  throws javax.mail.MessagingException,
                                         java.io.IOException

Returns the attachments as an Iterator of AttachmentData.

Returns:

the attachments as an Iterator of AttachmentData.

Throws:

javax.mail.MessagingException - if a server communication error occurs.

java.io.IOException - if a server communication error occurs.

getHeaders

java.util.Iterator getHeaders()
                              throws javax.mail.MessagingException

Returns the headers sent with the message as an Iterator of strings.

Returns:

the headers sent with the message as an Iterator of strings.

Throws:

javax.mail.MessagingException - if a server communication error occurs.

getHeader

java.lang.String[] getHeader(java.lang.String headerName)
                             throws javax.mail.MessagingException

Returns the header values corresponding to the supplied header name.

Parameters:

headerName - the name to supply values for. *

Returns:

the header values corresponding to the supplied header name.

Throws:

javax.mail.MessagingException - if a server communication error occurs.