org.adroitlogic.ultraesb.transport.mail
Class MailTransportListener

java.lang.Object
  org.adroitlogic.ultraesb.core.config.AbstractConfigurationElement
      org.adroitlogic.ultraesb.transport.base.AbstractTransportListener
          org.adroitlogic.ultraesb.transport.base.AbstractPollingTransportListener
              org.adroitlogic.ultraesb.transport.mail.MailTransportListener

All Implemented Interfaces:

ConfigurationElement, org.springframework.beans.factory.BeanNameAware, org.springframework.context.ApplicationContextAware

public class MailTransportListener
extends org.adroitlogic.ultraesb.transport.base.AbstractPollingTransportListener

The Email transport listener supporting POP3 and IMAP both with and without SSL

Most of the email transport configuration is performed at the transport configuration section of the Proxy service using the email transport. However, the standard Java POP3 or IMAP properties could be set at the email listener level (See sample # 501). Proxy services are triggered either on a specified cron expression, or as per specified {ultra.polling.start_delay, ultra.polling.repeat_interval, [ultra.polling.repeat_count]}

The available properties are as follows:

• url - the email account URL e.g. user@domain.ext
• ultra.polling.start_delay - number of milliseconds to wait before starting
• ultra.polling.repeat_interval - interval between successive polling runs specified in milli seconds
• ultra.polling.repeat_count - the number of iterations to execute the service (default: infinite)
• ultra.polling.cron_expression - an optional 'cron' expression specifying polling schedule - instead of a ultra.polling.start_delay and ultra.polling.repeat_interval
• ultra.polling.concurrent - true implies concurrent polling by multiple threads
• ultra.mail.move_after_process - folder to move the email after successful processing
• ultra.mail.move_after_failure - folder to move the email that fail processing
• ultra.mail.leave_after_failure - leave mail on server after failure, but flag as read
• ultra.mail.leave_after_process - leave mail on server after processing, but flag as read
• ultra.mail.concurrent_polling_allowed - allow same email account to be polled in parallel; usually while one download is still pending (e.g. with a large email) if set to true. Default is false
• ultra.mail.process_in_parallel - process messages in parallel for better throughput if set to true. Default is false
• ultra.mail.folder - folder to poll for messages. Defaults to INBOX
• ultra.mail.preserve_headers - A comma separated list of headers to preserve as transport headers. All other headers will be dropped. e.g. "To, Subject, From"
• ultra.mail.remove_headers - A comma separated list of headers to remove. All other headers will be retained as transport headers of the message
• ultra.mail.main_part_identification_priority - A comma separated list of content types to select which part is considered as the main body in a email with attachments
• Any other common mail.pop3.* or mail.imap.* property

Each Proxy service must define the service specific mail.pop3 or mail.imap properties such as:

• mail.imap.user or mail.pop3.user - user name
• mail.imap.password or mail.pop3.user - password
• And any other properties - such as those required for SSL (e.g. when using gmail)

e.g. see sample # 501

Nested Class Summary

Nested classes/interfaces inherited from class org.adroitlogic.ultraesb.transport.base.AbstractPollingTransportListener

org.adroitlogic.ultraesb.transport.base.AbstractPollingTransportListener.PollingJob

Nested classes/interfaces inherited from interface org.adroitlogic.ultraesb.api.ConfigurationElement

ConfigurationElement.State

Field Summary

Fields inherited from class org.adroitlogic.ultraesb.transport.base.AbstractTransportListener

metrics, properties, transportName

Fields inherited from class org.adroitlogic.ultraesb.core.config.AbstractConfigurationElement

config, ctx, debugOn, derivedName, id, outdated, state

Constructor Summary

MailTransportListener()
Default constructor

MailTransportListener(int threads)
Constructor specifying the number of threads to allocate

Method Summary

Methods inherited from class org.adroitlogic.ultraesb.transport.base.AbstractPollingTransportListener

customizeJobDataMap, execute, maintenanceShutdown, onPoll, pause, registerProxyService, resume, start, stop, unregisterProxyService

Methods inherited from class org.adroitlogic.ultraesb.transport.base.AbstractTransportListener

getAvgSizeReceived, getAvgSizeSent, getBytesReceived, getBytesSent, getDetails, getFaultsReceiving, getFaultsSending, getLastResetTime, getMaxSizeReceived, getMaxSizeSent, getMessagesReceived, getMessagesSent, getMetricsWindow, getMinSizeReceived, getMinSizeSent, getReceiveErrorCodeTable, getSendErrorCodeTable, getTimeoutsReceiving, getTimeoutsSending, init, resetStatistics, setProperties, toBasicView, toDetailedView, toDetailedViewExt

Methods inherited from class org.adroitlogic.ultraesb.core.config.AbstractConfigurationElement

equals, getAppCtx, getDerivedName, getId, getState, hashCode, isDebugOn, isStarted, markAsOutdated, setApplicationContext, setBeanName, setConfig, setDebugOn, setDerivedName, setId, setState, throwIllegalStateException, undeploy

Methods inherited from class java.lang.Object

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

Constructor Detail

MailTransportListener

public MailTransportListener()

Default constructor

MailTransportListener

public MailTransportListener(int threads)

Constructor specifying the number of threads to allocate

Parameters:

threads - threads to allocate to polling