com.atlassian.jira.service.services.mail
Class MailFetcherService

java.lang.Object
  com.atlassian.jira.service.AbstractService
      com.atlassian.jira.service.services.file.AbstractMessageHandlingService
          com.atlassian.jira.service.services.mail.MailFetcherService

All Implemented Interfaces:

com.atlassian.configurable.ObjectConfigurable, JiraService

Direct Known Subclasses:

ImapService, PopService

public abstract class MailFetcherService
extends AbstractMessageHandlingService
implements com.atlassian.configurable.ObjectConfigurable

An abstract mail fetcher for POP and IMAP protocols

Field Summary

protected static String	DEFAULT_FOLDER
static String	FORWARD_EMAIL
protected Long	mailserverId
static String	USE_SSL

Fields inherited from class com.atlassian.jira.service.services.file.AbstractMessageHandlingService

handler, KEY_HANDLER, KEY_HANDLER_PARAMS

Fields inherited from class com.atlassian.jira.service.AbstractService

name

Fields inherited from interface com.atlassian.jira.service.JiraService

NAME_COMPARATOR

Constructor Summary

MailFetcherService()

Method Summary

void	destroy() This method is called when the service is unloaded (usually when the web application or server is being shut down).
protected abstract String	getFolderName()
protected abstract String	getProtocol(boolean useSSL)
void	init(com.opensymphony.module.propertyset.PropertySet props) MUST pass 'mail-hostname', 'username' and 'password' as parameters
void	run() Connect to the POP / IMAPemail box and then handle each message.

Methods inherited from class com.atlassian.jira.service.services.file.AbstractMessageHandlingService

getHandler

Methods inherited from class com.atlassian.jira.service.AbstractService

getDefaultProperty, getDescription, getKey, getLongProperty, getName, getObjectConfiguration, getProperties, getProperty, getTextProperty, hasProperty, isInternal, isUnique, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.configurable.ObjectConfigurable

getDefaultProperty, getKey, getLongProperty, getObjectConfiguration, getProperties, getProperty, getTextProperty, hasProperty

Field Detail

mailserverId

protected Long mailserverId

USE_SSL

public static final String USE_SSL

See Also:

Constant Field Values

FORWARD_EMAIL

public static final String FORWARD_EMAIL

See Also:

Constant Field Values

DEFAULT_FOLDER

protected static final String DEFAULT_FOLDER

See Also:

Constant Field Values

Constructor Detail

MailFetcherService

public MailFetcherService()

Method Detail

init

public void init(com.opensymphony.module.propertyset.PropertySet props)
          throws com.atlassian.configurable.ObjectConfigurationException

MUST pass 'mail-hostname', 'username' and 'password' as parameters

Specified by:

init in interface JiraService

Overrides:

init in class AbstractMessageHandlingService

Parameters:

props - initialisation parameters

Throws:

com.atlassian.configurable.ObjectConfigurationException - in case of an error with initialisation parameters

destroy

public void destroy()

Description copied from class: AbstractService

This method is called when the service is unloaded (usually when the web application or server is being shut down).

You may wish to remove any connections that you have established, eg. database connections.

Specified by:

destroy in interface JiraService

Overrides:

destroy in class AbstractService

run

public void run()

Connect to the POP / IMAPemail box and then handle each message.

Specified by:

run in interface JiraService

Specified by:

run in class AbstractService

See Also:

JiraService.init(com.opensymphony.module.propertyset.PropertySet)

getProtocol

protected abstract String getProtocol(boolean useSSL)

getFolderName

protected abstract String getFolderName()