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:
- EventListener, javax.resource.spi.work.WorkListener, Disposable, Initialisable, Lifecycle, LifecycleStateEnabled, Startable, Stoppable, NameableObject, 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).
Fields inherited from class org.mule.transport.AbstractConnector |
createMultipleTransactedReceivers, DEFAULT_NUM_CONCURRENT_TX_RECEIVERS, dispatcherFactory, dispatcherPoolFactory, dispatchers, initialStateStopped, lifecycleManager, logger, muleContext, muleMessageFactory, name, numberOfConcurrentTransactedReceivers, PROPERTY_POLLING_FREQUENCY, receivers, requesterFactory, requesters, serviceDescriptor, serviceOverrides, sessionHandler, startOnConnect |
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 |
clearDispatchers, clearRequesters, configureDispatcherPool, connect, createDefaultRedeliveryPolicy, createDispatcherMessageProcessor, createMuleMessageFactory, createOperationResource, createScheduler, destroyReceiver, disconnect, dispose, disposeReceivers, disposeWorkManagers, doUnregisterListener, fireNotification, getConnectEventId, getConnectionDescription, getDefaultExchangePattern, getDefaultInboundTransformers, getDefaultOutboundTransformers, getDefaultResponseTransformers, getDispatcherFactory, getDispatcherPoolFactory, getDispatcherThreadingProfile, getDispatcherWorkManager, getInboundExchangePatterns, getLifecycleState, getMaxDispatchersActive, getMaxRequestersActive, getMaxTotalDispatchers, getMuleContext, getMuleMessageFactory, getName, getNumberOfConcurrentTransactedReceivers, getOperationResourceFactory, getOutboundExchangePatterns, getOutputStream, getReceiver, getReceiverKey, getReceivers, getReceivers, getReceiverThreadingProfile, getReceiverWorkManager, getReplyToHandler, getRequesterFactory, getRequesterThreadingProfile, getRequesterWorkManager, getRetryPolicyTemplate, getScheduler, getServiceDescriptor, getServiceOverrides, getSessionHandler, getSupportedProtocols, getTransactionalResource, handleWorkException, initFromServiceDescriptor, initialise, initialiseFromUrl, initWorkManagers, isConnected, isConnecting, isCreateMultipleTransactedReceivers, isDisposed, isEnableMessageEvents, isInitialised, isInitialStateStopped, isResponseEnabled, isStarted, isStarting, isStopped, isStopping, isValidateConnections, lookupReceiver, registerListener, registerSupportedMetaProtocol, registerSupportedProtocol, registerSupportedProtocolWithoutPrefix, request, request, setConnected, setConnecting, setCreateMultipleTransactedReceivers, setDispatcherFactory, setDispatcherPoolFactory, setDispatcherPoolMaxWait, setDispatcherPoolWhenExhaustedAction, setDispatcherThreadingProfile, setDynamicNotification, setInitialStateStopped, setMaxDispatchersActive, setMaxRequestersActive, setName, setNumberOfConcurrentTransactedReceivers, setReceiverThreadingProfile, setRequesterFactory, setRequesterPoolMaxWait, setRequesterPoolWhenExhaustedAction, setRequesterThreadingProfile, setRetryPolicyTemplate, setServiceOverrides, setSessionHandler, setSupportedProtocols, setupDispatchReturn, setupRequestReturn, setValidateConnections, shutdownScheduler, start, startAfterConnect, stop, supportsProtocol, toString, unregisterListener, unregisterSupportedProtocol, updateCachedNotificationHandler, validateConnection, workAccepted, workCompleted, workRejected, workStarted |
DEFAULT_CHECK_FREQUENCY
public static final int DEFAULT_CHECK_FREQUENCY
- See Also:
- Constant Field Values
AbstractRetrieveMailConnector
protected AbstractRetrieveMailConnector(int defaultPort,
MuleContext context)
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(FlowConstruct flowConstruct,
InboundEndpoint endpoint)
throws Exception
- Description copied from class:
AbstractConnector
- Create a Message receiver for this connector
- Overrides:
createReceiver
in class AbstractConnector
- Parameters:
flowConstruct
- the service that will receive events from this receiver, the
listenerendpoint
- 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
isDeleteReadMessages
public boolean isDeleteReadMessages()
setDeleteReadMessages
public void setDeleteReadMessages(boolean deleteReadMessages)
isBackupEnabled
public boolean isBackupEnabled()
setBackupEnabled
public void setBackupEnabled(boolean backupEnabled)
getMoveToFolder
public String getMoveToFolder()
setMoveToFolder
public void setMoveToFolder(String moveToFolder)
getDefaultProcessMessageAction
public Flags.Flag getDefaultProcessMessageAction()
setDefaultProcessMessageAction
public void setDefaultProcessMessageAction(Flags.Flag defaultProcessMessageAction)
Copyright © 2003-2012 MuleSoft, Inc.. All Rights Reserved.