org.opennms.javamail

Class JavaReadMailer

java.lang.Object

org.opennms.javamail.JavaMailer2

org.opennms.javamail.JavaReadMailer

public class JavaReadMailer
extends JavaMailer2

JavaMail implementation for reading electronic mail.

Version:

$Id: $

Author:

David Hustace

Nested Class Summary

Nested classes/interfaces inherited from class org.opennms.javamail.JavaMailer2

JavaMailer2.LoggingByteArrayOutputStream, JavaMailer2.LoggingTransportListener

Constructor Summary

Constructors

Constructor and Description
JavaReadMailer(ReadmailConfig config, Boolean closeOnDelete) Constructor for JavaReadMailer.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	finalize() Finalizer to be sure and close with the appropriate mode any open folders
List<javax.mail.Message>	getMessages() getMessages
static List<String>	getText(javax.mail.Message msg) Attempts to reteive the string portion of a message...
Boolean	isDeleteOnClose() isDeleteOnClose
List<javax.mail.Message>	retrieveMessages() retrieveMessages
List<javax.mail.Message>	retrieveMessages(javax.mail.search.SearchTerm term) retrieveMessages
void	setDeleteOnClose(Boolean deleteOnClose) setDeleteOnClose
static List<String>	string2Lines(String text) string2Lines

Methods inherited from class org.opennms.javamail.JavaMailer2

createAuthenticator, createFileAttachment, getMailProps, getSession, log, setDebug, setSession

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JavaReadMailer

public JavaReadMailer(ReadmailConfig config,
              Boolean closeOnDelete)
               throws JavaMailerException

Constructor for JavaReadMailer.

Parameters:

config - a ReadmailConfig object.

closeOnDelete - a Boolean object.

Throws:

JavaMailerException - if any.

Method Detail

finalize

protected void finalize()
                 throws Throwable

Finalizer to be sure and close with the appropriate mode any open folders

Overrides:

finalize in class Object

Throws:

Throwable

retrieveMessages

public List<javax.mail.Message> retrieveMessages()
                                          throws JavaMailerException

retrieveMessages

Returns:

a List object.

Throws:

JavaMailerException - if any.

retrieveMessages

public List<javax.mail.Message> retrieveMessages(javax.mail.search.SearchTerm term)
                                          throws JavaMailerException

retrieveMessages

Parameters:

term - a SearchTerm object.

Returns:

a List object.

Throws:

JavaMailerException - if any.

getMessages

public List<javax.mail.Message> getMessages()

getMessages

Returns:

a List object.

getText

public static List<String> getText(javax.mail.Message msg)
                            throws javax.mail.MessagingException,
                                   IOException

Attempts to reteive the string portion of a message... tries to handle multipart messages as well. This seems to be working so far with my tests but could use some tweaking later as more types of mail servers are used with this feature.

Parameters:

msg - a Message object.

Returns:

The text portion of an email with each line being an element of the list.

Throws:

javax.mail.MessagingException - if any.

IOException - if any.

isDeleteOnClose

public Boolean isDeleteOnClose()

isDeleteOnClose

Returns:

a Boolean object.

setDeleteOnClose

public void setDeleteOnClose(Boolean deleteOnClose)

setDeleteOnClose

Parameters:

deleteOnClose - a Boolean object.

string2Lines

public static List<String> string2Lines(String text)

string2Lines

Parameters:

text - a String object.

Returns:

a List object.