org.mule.transport.email
Class AbstractRetrieveMailConnector

java.lang.Object
  org.mule.transport.AbstractConnector
      org.mule.transport.email.AbstractMailConnector
          org.mule.transport.email.AbstractRetrieveMailConnector

All Implemented Interfaces:

ExceptionListener, EventListener, javax.resource.spi.work.WorkListener, MuleContextAware, Disposable, Initialisable, Lifecycle, Startable, Stoppable, NamedObject, Connectable, Connector

Direct Known Subclasses:

AbstractTlsRetrieveMailConnector, ImapConnector, Pop3Connector

public abstract class AbstractRetrieveMailConnector
extends AbstractMailConnector

Support for connecting to and receiving email from a mailbox (the exact protocol depends on the subclass).

Field Summary

static int

DEFAULT_CHECK_FREQUENCY

Fields inherited from class org.mule.transport.email.AbstractMailConnector

MAILBOX

Fields inherited from class org.mule.transport.AbstractConnector

connected, createMultipleTransactedReceivers, DEFAULT_NUM_CONCURRENT_TX_RECEIVERS, dispatcherFactory, dispatchers, disposed, exceptionListener, initialised, logger, muleContext, name, numberOfConcurrentTransactedReceivers, receivers, requesterFactory, requesters, serviceDescriptor, serviceOverrides, sessionHandler, started, startOnConnect

Fields inherited from interface org.mule.api.transport.Connector

INT_VALUE_NOT_SET

Fields inherited from interface org.mule.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Stoppable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

protected

AbstractRetrieveMailConnector(int defaultPort)

Method Summary

MessageReceiver	createReceiver(Service service, InboundEndpoint endpoint) Create a Message receiver for this connector
String	getBackupFolder()
long	getCheckFrequency()
boolean	isBackupEnabled()
boolean	isDeleteReadMessages()
void	setBackupEnabled(boolean backupEnabled)
void	setBackupFolder(String string)
void	setCheckFrequency(long l)
void	setDeleteReadMessages(boolean deleteReadMessages)

Methods inherited from class org.mule.transport.email.AbstractMailConnector

doConnect, doDisconnect, doDispose, doInitialise, doStart, doStop, dumpProperties, extendPropertiesForSession, getAuthenticator, getBaseProtocol, getDefaultPort, getMailboxFolder, getSessionDetails, newSession, setAuthenticator, setMailboxFolder, urlFromEndpoint

Methods inherited from class org.mule.transport.AbstractConnector

checkDisposed, connect, destroyReceiver, disconnect, dispatch, dispose, disposeDispatchers, disposeReceivers, disposeRequesters, disposeWorkManagers, exceptionThrown, fireNotification, getConnectEventId, getConnectionDescription, getDefaultInboundTransformers, getDefaultOutboundTransformers, getDefaultResponseTransformers, getDispatcherFactory, getDispatcherThreadingProfile, getDispatcherWorkManager, getExceptionListener, getMaxDispatchersActive, getMaxRequestersActive, getMessageAdapter, getMuleContext, getName, getNumberOfConcurrentTransactedReceivers, getOutputStream, getReceiver, getReceiverKey, getReceivers, getReceivers, getReceiverThreadingProfile, getReceiverWorkManager, getReplyToHandler, getRequesterFactory, getRequesterThreadingProfile, getRequesterWorkManager, getRetryPolicyTemplate, getScheduler, getServiceDescriptor, getServiceOverrides, getSessionHandler, getSupportedProtocols, handleException, handleException, handleWorkException, initFromServiceDescriptor, initialise, initialiseFromUrl, initWorkManagers, isConnected, isCreateMultipleTransactedReceivers, isDisposed, isEnableMessageEvents, isResponseEnabled, isStarted, isSyncEnabled, isValidateConnections, lookupReceiver, registerListener, registerSupportedProtocol, registerSupportedProtocolWithoutPrefix, request, request, send, setConnected, setCreateMultipleTransactedReceivers, setDispatcherFactory, setDispatcherThreadingProfile, setDynamicNotification, setExceptionListener, setMaxDispatchersActive, setMaxRequestersActive, setMuleContext, setName, setNumberOfConcurrentTransactedReceivers, setReceiverThreadingProfile, setRequesterFactory, setRequesterThreadingProfile, setRetryPolicyTemplate, setServiceOverrides, setSessionHandler, setSupportedProtocols, setupDispatchReturn, setupRequestReturn, setValidateConnections, start, stop, supportsProtocol, toString, unregisterListener, unregisterSupportedProtocol, updateCachedNotificationHandler, validateConnection, workAccepted, workCompleted, workRejected, workStarted

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.api.transport.Connector

getProtocol

Field Detail

DEFAULT_CHECK_FREQUENCY

public static final int DEFAULT_CHECK_FREQUENCY

See Also:

Constant Field Values

Constructor Detail

AbstractRetrieveMailConnector

protected AbstractRetrieveMailConnector(int defaultPort)

Method Detail

getCheckFrequency

public long getCheckFrequency()

Returns:

the milliseconds between checking the folder for messages

setCheckFrequency

public void setCheckFrequency(long l)

getBackupFolder

public String getBackupFolder()

Returns:

a relative or absolute path to a directory on the file system

setBackupFolder

public void setBackupFolder(String string)

createReceiver

public MessageReceiver createReceiver(Service service,
                                      InboundEndpoint endpoint)
                               throws Exception

Description copied from class: AbstractConnector

Create a Message receiver for this connector

Overrides:

createReceiver in class AbstractConnector

Parameters:

service - the service that will receive events from this receiver, the listener

endpoint - the endpoint that defies this inbound communication

Returns:

an instance of the message receiver defined in this connectors' TransportServiceDescriptor initialised using the service and endpoint.

Throws:

Exception - if there is a problem creating the receiver. This exception really depends on the underlying transport, thus any exception could be thrown

See Also:

Connector.registerListener(org.mule.api.service.Service, org.mule.api.endpoint.InboundEndpoint)

isDeleteReadMessages

public boolean isDeleteReadMessages()

setDeleteReadMessages

public void setDeleteReadMessages(boolean deleteReadMessages)

isBackupEnabled

public boolean isBackupEnabled()

setBackupEnabled

public void setBackupEnabled(boolean backupEnabled)