org.jboss.jca.adapters.mail.inflow

Class MailFolder

java.lang.Object

org.jboss.jca.adapters.mail.inflow.MailFolder

All Implemented Interfaces:

java.util.Iterator

Direct Known Subclasses:

IMAPMailFolder, POP3MailFolder

public abstract class MailFolder
extends java.lang.Object
implements java.util.Iterator

An encapsulation of a mail store folder used by the MailActivation.run to poll and retrieve new messages.

Author:

Scott Stark, Jesper Pedersen

Constructor Summary

Constructors

Constructor and Description
MailFolder(MailActivationSpec spec) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the mail session
protected void	close(boolean checkSuccessful) Closes a mail session
protected abstract void	closeStore(boolean success, Store store, Folder folder) Close a store
static MailFolder	getInstance(MailActivationSpec mailActivationSpec) Get an instance of a mail folder
protected abstract Message[]	getMessages(Folder folder) Get the messages from a folder
boolean	hasNext()
protected abstract void	markMessageSeen(Message message) Mark a message as seen
java.lang.Object	next()
void	open() Open a mail session
protected abstract Store	openStore(Session session) Open a store
void	remove()

Methods inherited from class java.lang.Object

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

Constructor Detail

MailFolder

public MailFolder(MailActivationSpec spec)

Constructor

Parameters:

spec - The mail activation spec

Method Detail

open

public void open()
          throws java.lang.Exception

Open a mail session

Throws:

java.lang.Exception - Thrown if a session can't be established

close

public void close()
           throws MessagingException

Closes the mail session

Throws:

MessagingException - Thrown if an error occurs duing close

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator

next

public java.lang.Object next()

Specified by:

next in interface java.util.Iterator

remove

public void remove()

Specified by:

remove in interface java.util.Iterator

close

protected void close(boolean checkSuccessful)

Closes a mail session

Parameters:

checkSuccessful - Check if it was a successful close

getInstance

public static MailFolder getInstance(MailActivationSpec mailActivationSpec)

Get an instance of a mail folder

Parameters:

mailActivationSpec - The mail activation spec

Returns:

The mail folder; null if not IMAP / POP based

openStore

protected abstract Store openStore(Session session)
                            throws NoSuchProviderException

Open a store

Parameters:

session - The mail session

Returns:

The store

Throws:

NoSuchProviderException - Thrown if there is no provider

closeStore

protected abstract void closeStore(boolean success,
              Store store,
              Folder folder)
                            throws MessagingException

Close a store

Parameters:

success - Check for successful close

store - The store

folder - The folder

Throws:

MessagingException - Thrown if there is an error

getMessages

protected abstract Message[] getMessages(Folder folder)
                                  throws MessagingException

Get the messages from a folder

Parameters:

folder - The folder

Returns:

The messages

Throws:

MessagingException - Thrown if there is an error

markMessageSeen

protected abstract void markMessageSeen(Message message)
                                 throws MessagingException

Mark a message as seen

Parameters:

message - The messages

Throws:

MessagingException - Thrown if there is an error