org.mule.providers.email
Class Pop3Connector

java.lang.Object
  org.mule.providers.AbstractConnector
      org.mule.providers.AbstractServiceEnabledConnector
          org.mule.providers.email.Pop3Connector

All Implemented Interfaces:

org.mule.umo.lifecycle.Disposable, EventListener, ExceptionListener, org.mule.umo.lifecycle.Initialisable, MailConnector, org.mule.umo.provider.UMOConnectable, org.mule.umo.provider.UMOConnector, WorkListener

Direct Known Subclasses:

ImapConnector, Pop3sConnector

public class Pop3Connector

extends org.mule.providers.AbstractServiceEnabledConnector

implements MailConnector

Pop3Connector is used to connect and receive mail from a POP3 mailbox

Field Summary

protected Authenticator	authenticator A custom authenticator to bew used on any mail sessions created with this connector This will only be used if user name credendtials are set on the endpoint
protected String	backupFolder holds a path where messages should be backed up to
protected long	checkFrequency Holds the time in milliseconds that the endpoint should wait before checking a mailbox
static int	DEFAULT_CHECK_FREQUENCY
static int	DEFAULT_POP3_PORT
protected boolean	deleteReadMessages Once a message has been read, should it be deleted
static String	MAILBOX

Fields inherited from class org.mule.providers.AbstractServiceEnabledConnector

serviceDescriptor, serviceOverrides

Fields inherited from class org.mule.providers.AbstractConnector

connected, connecting, createDispatcherPerRequest, createMultipleTransactedReceivers, defaultInboundTransformer, defaultOutboundTransformer, defaultResponseTransformer, dispatcherFactory, dispatchers, disposed, disposing, exceptionListener, initialised, logger, name, receivers, serverSide, sessionHandler, started, startOnConnect

Fields inherited from interface org.mule.umo.provider.UMOConnector

INT_VALUE_NOT_SET

Constructor Summary

Pop3Connector()

Method Summary

org.mule.umo.provider.UMOMessageReceiver	createReceiver(org.mule.umo.UMOComponent component, org.mule.umo.endpoint.UMOEndpoint endpoint)
Authenticator	getAuthenticator()
String	getBackupFolder()
long	getCheckFrequency()
int	getDefaultPort()
String	getProtocol()
boolean	isDeleteReadMessages()
void	setAuthenticator(Authenticator authenticator)
void	setBackupFolder(String string)
void	setCheckFrequency(long l)
void	setDeleteReadMessages(boolean deleteReadMessages)

Methods inherited from class org.mule.providers.AbstractServiceEnabledConnector

doInitialise, getMessageAdapter, getServiceDescriptor, getServiceOverrides, getStreamMessageAdapter, initFromServiceDescriptor, initialiseFromUrl, setServiceOverrides

Methods inherited from class org.mule.providers.AbstractConnector

checkDisposed, connect, createDispatcher, destroyReceiver, disconnect, dispose, disposeDispatchers, disposeReceivers, doConnect, doDisconnect, doDispose, doStart, doStop, exceptionThrown, fireNotification, getConnectEventId, getConnectionDescription, getConnectionStrategy, getDefaultInboundTransformer, getDefaultOutboundTransformer, getDefaultResponseTransformer, getDispatcher, getDispatcher, getDispatcherFactory, getDispatchers, getDispatcherThreadingProfile, getExceptionListener, getName, getReceiver, getReceiver, getReceiverKey, getReceivers, getReceivers, getReceiverThreadingProfile, getReplyToHandler, getSessionHandler, getSupportedProtocols, handleException, handleWorkException, initialise, isConnected, isCreateDispatcherPerRequest, isCreateMultipleTransactedReceivers, isDisposed, isDisposing, isEnableMessageEvents, isRemoteSyncEnabled, isServerSide, isStarted, isUseSingleDispatcherThreadPool, isUseSingleReceiverThreadPool, lookupDispatcher, lookupReceiver, registerListener, registerSupportedProtocol, registerSupportedProtocolWithotPrefix, setConnectionStrategy, setCreateDispatcherPerRequest, setCreateMultipleTransactedReceivers, setDefaultInboundTransformer, setDefaultOutboundTransformer, setDefaultResponseTransformer, setDispatcherFactory, setDispatcherThreadingProfile, setEnableMessageEvents, setExceptionListener, setName, setReceiverThreadingProfile, setServerSide, setSessionHandler, setSupportedProtocols, setUseSingleDispatcherThreadPool, setUseSingleReceiverThreadPool, startConnector, stopConnector, supportsProtocol, unregisterListener, unregisterSupportedProtocol, workAccepted, workCompleted, workRejected, workStarted

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.umo.provider.UMOConnector

getDispatcher, getDispatcherFactory, getExceptionListener, getMessageAdapter, getName, getStreamMessageAdapter, handleException, isDisposed, isDisposing, isRemoteSyncEnabled, isStarted, registerListener, setDispatcherFactory, setExceptionListener, setName, startConnector, stopConnector, supportsProtocol, unregisterListener

Methods inherited from interface org.mule.umo.lifecycle.Disposable

dispose

Methods inherited from interface org.mule.umo.lifecycle.Initialisable

initialise

Field Detail

MAILBOX

public static final String MAILBOX

See Also:

Constant Field Values

DEFAULT_POP3_PORT

public static final int DEFAULT_POP3_PORT

See Also:

Constant Field Values

DEFAULT_CHECK_FREQUENCY

public static final int DEFAULT_CHECK_FREQUENCY

See Also:

Constant Field Values

checkFrequency

protected long checkFrequency

Holds the time in milliseconds that the endpoint should wait before checking a mailbox

backupFolder

protected String backupFolder

holds a path where messages should be backed up to

authenticator

protected Authenticator authenticator

A custom authenticator to bew used on any mail sessions created with this connector This will only be used if user name credendtials are set on the endpoint

deleteReadMessages

protected boolean deleteReadMessages

Once a message has been read, should it be deleted

Constructor Detail

Pop3Connector

public Pop3Connector()

Method Detail

getCheckFrequency

public long getCheckFrequency()

Returns:

the milliseconds between checking the folder for messages

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface org.mule.umo.provider.UMOConnector

setCheckFrequency

public void setCheckFrequency(long l)

Parameters:

l -

getBackupFolder

public String getBackupFolder()

Returns:

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

setBackupFolder

public void setBackupFolder(String string)

Parameters:

string -

createReceiver

public org.mule.umo.provider.UMOMessageReceiver createReceiver(org.mule.umo.UMOComponent component,
                                                               org.mule.umo.endpoint.UMOEndpoint endpoint)
                                                        throws Exception

Throws:

Exception

getAuthenticator

public Authenticator getAuthenticator()

Specified by:

getAuthenticator in interface MailConnector

setAuthenticator

public void setAuthenticator(Authenticator authenticator)

getDefaultPort

public int getDefaultPort()

Specified by:

getDefaultPort in interface MailConnector

isDeleteReadMessages

public boolean isDeleteReadMessages()

setDeleteReadMessages

public void setDeleteReadMessages(boolean deleteReadMessages)