com.communote.server.core.mail.fetching

Class MailboxConnection

java.lang.Object

com.communote.server.core.mail.fetching.MailboxConnection

Direct Known Subclasses:

ImapMailboxConnection

public abstract class MailboxConnection
extends Object

Used to connect to a mailbox using a specific protocol for retrieving messages. Possible implementations of this abstract class are IMAP and POP3 based mailbox connections.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
MailboxConnection()

Method Summary

Modifier and Type	Method and Description
void	disconnect() Closes the connection to the mail server.
abstract boolean	expungeMessages() Expunge messages with the deleted flag.
protected long	getFetchTimeout()
protected abstract javax.mail.Folder	getFolder() Returns the mailbox folder or null if not initialized or available.
protected javax.mail.Store	getMessageStore()
abstract String	getProtocolName() Returns the name of the protocol used by this connection (e.g.
abstract String	getUniqueMessageId(javax.mail.Message message) Returns a unique id for an email message.
boolean	initialize() Initializes the connection from configuration properties using the ConfigurationManager.
protected boolean	isShouldStop()
protected abstract void	prepareFetching(String mailbox) Subclasses should use this method for protocol specific initialization.
protected abstract void	processUndeletedMessages(MailMessageWorker worker) Processes all undeleted messages in a mailbox.
protected abstract void	startCheckMessages() Starts checking for messages and blocks until another thread calls the disconnect() method or an error or exception (e.g.
void	startListening(MailMessageWorker worker) First tries to open the connection to the mail server.
protected abstract void	stopCheckMessages() Interrupt the check messages loop that was started in startCheckMessages().

Methods inherited from class java.lang.Object

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

Constructor Detail

MailboxConnection

public MailboxConnection()

Method Detail

disconnect

public void disconnect()

Closes the connection to the mail server. This method will block until the connection is closed.

expungeMessages

public abstract boolean expungeMessages()

Expunge messages with the deleted flag. See java mail API for protocol specific considerations when implementing this method.

Returns:

true if the operation succeeded

getFetchTimeout

protected long getFetchTimeout()

Returns:

the fetchTimeout

getFolder

protected abstract javax.mail.Folder getFolder()

Returns the mailbox folder or null if not initialized or available.

Returns:

the folder

getMessageStore

protected javax.mail.Store getMessageStore()

Returns:

the messageStore

getProtocolName

public abstract String getProtocolName()

Returns the name of the protocol used by this connection (e.g. "imap" or "pop3").

Returns:

the protocol name

getUniqueMessageId

public abstract String getUniqueMessageId(javax.mail.Message message)

Returns a unique id for an email message.

Parameters:

message - the message

Returns:

the unique id

initialize

public boolean initialize()

Initializes the connection from configuration properties using the ConfigurationManager. This does not include opening the connection to the mail server.

Returns:

true on success or false if the initialization fails for some reason like a configuration problem

isShouldStop

protected boolean isShouldStop()

Returns:

the shouldStop

prepareFetching

protected abstract void prepareFetching(String mailbox)
                                 throws MailboxConnectionException

Subclasses should use this method for protocol specific initialization. This includes for instance testing if the mailbox exists and can be opened with read and write access rights.

Parameters:

mailbox - the mailbox to use. Subclasses should ignore this parameter if they only support a specific mailbox

Throws:

MailboxConnectionException - if the connection to the mailbox (folder) failed or was lost

processUndeletedMessages

protected abstract void processUndeletedMessages(MailMessageWorker worker)

Processes all undeleted messages in a mailbox. Because there are differences when working with imap and pop3 folders (regarding opening and keeping open) subclasses must implement this method.

Parameters:

worker - the worker processing the messages

startCheckMessages

protected abstract void startCheckMessages()
                                    throws MailboxConnectionException

Starts checking for messages and blocks until another thread calls the disconnect() method or an error or exception (e.g. connection closed, server unreachable) occurs.

Throws:

MailboxConnectionException - in case the message check loop was interrupted by an error or exception

startListening

public void startListening(MailMessageWorker worker)
                    throws MailboxConnectionException

First tries to open the connection to the mail server. If this succeeded a listener is attached to the mailbox and all messages missed while not listening will be processed. Afterwards the check messages loop is entered, which blocks until an exception occurs or another thread stops the loop by calling disconnect().

Parameters:

worker - the worker that will be invoked to process messages

Throws:

MailboxConnectionException - if an error or exception occurs while connecting or listening

stopCheckMessages

protected abstract void stopCheckMessages()

Interrupt the check messages loop that was started in startCheckMessages(). This method should only be run from another thread than the one that called startCheckMessages().