com.communote.server.core.mail.fetching

Class ImapMailboxConnection

java.lang.Object

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

com.communote.server.core.mail.fetching.ImapMailboxConnection

public class ImapMailboxConnection
extends MailboxConnection

MailboxConnection implementation using the IMAP protocol.

Author:

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

Constructor Summary

Constructors

Constructor and Description
ImapMailboxConnection(boolean secure)

Method Summary

Modifier and Type	Method and Description
boolean	expungeMessages() Expunge messages with the deleted flag.
protected javax.mail.Folder	getFolder() Returns the mailbox folder or null if not initialized or available.
String	getProtocolName() Returns the name of the protocol used by this connection (e.g.
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 void	prepareFetching(String mailbox) Subclasses should use this method for protocol specific initialization.
protected void	processUndeletedMessages(MailMessageWorker worker) Processes all undeleted messages in a mailbox.
protected void	startCheckMessages() Starts checking for messages and blocks until another thread calls the MailboxConnection.disconnect() method or an error or exception (e.g.
protected void	stopCheckMessages() Interrupt the check messages loop that was started in MailboxConnection.startCheckMessages().

Methods inherited from class com.communote.server.core.mail.fetching.MailboxConnection

disconnect, getFetchTimeout, getMessageStore, isShouldStop, startListening

Methods inherited from class java.lang.Object

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

Constructor Detail

ImapMailboxConnection

public ImapMailboxConnection(boolean secure)

Parameters:

secure - whether to use a secure connection exists or not

Method Detail

expungeMessages

public boolean expungeMessages()

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

Specified by:

expungeMessages in class MailboxConnection

Returns:

true if the operation succeeded

getFolder

protected javax.mail.Folder getFolder()

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

Specified by:

getFolder in class MailboxConnection

Returns:

the folder

getProtocolName

public String getProtocolName()

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

Specified by:

getProtocolName in class MailboxConnection

Returns:

the protocol name

getUniqueMessageId

public String getUniqueMessageId(javax.mail.Message message)

Returns a unique id for an email message.

Specified by:

getUniqueMessageId in class MailboxConnection

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.

Overrides:

initialize in class MailboxConnection

Returns:

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

prepareFetching

protected 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.

Specified by:

prepareFetching in class MailboxConnection

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 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.

Specified by:

processUndeletedMessages in class MailboxConnection

Parameters:

worker - the worker processing the messages

startCheckMessages

protected void startCheckMessages()
                           throws MailboxConnectionException

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

Specified by:

startCheckMessages in class MailboxConnection

Throws:

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

stopCheckMessages

protected void stopCheckMessages()

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

Specified by:

stopCheckMessages in class MailboxConnection