com.communote.server.core.mail.fetching

Class MailFetcher

java.lang.Object

com.communote.server.core.mail.fetching.MailFetcher

public class MailFetcher
extends Object

Author:

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MailFetcher() private constructor

Method Summary

Modifier and Type	Method and Description
boolean	deleteMessage(javax.mail.Message message) Deletes an email message.
boolean	expungeMessages() Expunge (permanently remove) messages having the deleted flag.
String	getUniqueMessageId(javax.mail.Message message) Returns a unique id for an email message.
static MailFetcher	instance() Returns the singleton instance of the MailFetcher.
void	shutdown() Stops the mail-fetcher.
void	startFetching(MailMessageWorker worker) Blocking method which starts fetching mails.

Methods inherited from class java.lang.Object

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

Constructor Detail

MailFetcher

protected MailFetcher()

private constructor

Method Detail

instance

public static MailFetcher instance()

Returns the singleton instance of the MailFetcher.

Returns:

the instance of the MailFetcher or null if the initialization of the fetcher failed (due to configuration problems).

deleteMessage

public boolean deleteMessage(javax.mail.Message message)

Deletes an email message.

Parameters:

message - the message

Returns:

true if the email message was deleted successfully (which means the deleted flag was set), false otherwise

expungeMessages

public boolean expungeMessages()

Expunge (permanently remove) messages having the deleted flag.

Returns:

true if the operation succeeded, false otherwise

getUniqueMessageId

public String getUniqueMessageId(javax.mail.Message message)

Returns a unique id for an email message.

Parameters:

message - the message

Returns:

the unique id or null if not found

shutdown

public void shutdown()

Stops the mail-fetcher.

startFetching

public void startFetching(MailMessageWorker worker)
                   throws MailboxConnectionException

Blocking method which starts fetching mails. All mails found which do not have the deleted flag will be passed to the mail message worker. The method only returns in case of an error (e.g. connection to the mail server was lost) or when another thread called the shutdown() method.

Parameters:

worker - used for processing mails

Throws:

MailboxConnectionException - if an error or exception occurs while connecting or listening. The exception holds information whether a restart at a later time may succeed.