org.mule.providers.email
Class Pop3MessageDispatcher

java.lang.Object
  org.mule.providers.AbstractMessageDispatcher
      org.mule.providers.email.Pop3MessageDispatcher

All Implemented Interfaces:

org.mule.umo.lifecycle.Disposable, ExceptionListener, org.mule.umo.provider.UMOConnectable, org.mule.umo.provider.UMOMessageDispatcher

public class Pop3MessageDispatcher

extends org.mule.providers.AbstractMessageDispatcher

Pop3MessageDispatcher For Pop3 connections the dispatcher can only be used to receive message (as opposed to listening for them). Trying to send or dispatch will throw an UnsupportedOperationException.

Field Summary

Fields inherited from class org.mule.providers.AbstractMessageDispatcher

connected, connectionStrategy, disposed, doThreading, endpoint, logger, workManager

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

RECEIVE_NO_WAIT, RECEIVE_WAIT_INDEFINITELY

Constructor Summary

Pop3MessageDispatcher(org.mule.umo.endpoint.UMOImmutableEndpoint endpoint)

Method Summary

protected void	doConnect(org.mule.umo.endpoint.UMOImmutableEndpoint endpoint)
protected void	doDisconnect()
protected void	doDispatch(org.mule.umo.UMOEvent event)
protected void	doDispose()
protected org.mule.umo.UMOMessage	doReceive(org.mule.umo.endpoint.UMOImmutableEndpoint endpoint, long timeout) Make a specific request to the underlying transport Endpoint can be in the form of pop3://username:password@pop3.lotsofmail.org
protected org.mule.umo.UMOMessage	doSend(org.mule.umo.UMOEvent event)
protected void	flagMessage(Folder folder, Message message) There seems to be som variation on pop3 implementation so it may be preferrable to mark messages as seen here and alos overload the getMessages method to grab only new messages
org.mule.umo.provider.UMOConnector	getConnector()
Object	getDelegateSession()
protected int	getMessageCount(Folder folder)
protected Message	getNextMessage(Folder folder)
protected boolean	hasMessages(Folder folder) Optimised check to se whether to return the message count and retrieve the messages.

Methods inherited from class org.mule.providers.AbstractMessageDispatcher

connect, disconnect, dispatch, dispose, exceptionThrown, getConnectEventId, getConnectionDescription, getOutputStream, isConnected, isDisposed, isTransactionRollback, receive, receive, reconnect, send, useRemoteSync

Methods inherited from class java.lang.Object

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

Constructor Detail

Pop3MessageDispatcher

public Pop3MessageDispatcher(org.mule.umo.endpoint.UMOImmutableEndpoint endpoint)

Method Detail

doConnect

protected void doConnect(org.mule.umo.endpoint.UMOImmutableEndpoint endpoint)
                  throws Exception

Throws:

Exception

doDisconnect

protected void doDisconnect()
                     throws Exception

Throws:

Exception

doDispatch

protected void doDispatch(org.mule.umo.UMOEvent event)
                   throws Exception

Parameters:

event -

Throws:

UnsupportedOperationException

Exception

doSend

protected org.mule.umo.UMOMessage doSend(org.mule.umo.UMOEvent event)
                                  throws Exception

Parameters:

event -

Returns:

Throws:

UnsupportedOperationException

Exception

doReceive

protected org.mule.umo.UMOMessage doReceive(org.mule.umo.endpoint.UMOImmutableEndpoint endpoint,
                                            long timeout)
                                     throws Exception

Make a specific request to the underlying transport Endpoint can be in the form of pop3://username:password@pop3.lotsofmail.org

Parameters:

endpoint - the endpoint to use when connecting to the resource

timeout - the maximum time the operation should block before returning. The call should return immediately if there is data available. If no data becomes available before the timeout elapses, null will be returned

Returns:

the result of the request wrapped in a UMOMessage object. Null will be returned if no data was avaialable

Throws:

Exception - if the call to the underlying protocal cuases an exception

flagMessage

protected void flagMessage(Folder folder,
                           Message message)
                    throws MessagingException

There seems to be som variation on pop3 implementation so it may be preferrable to mark messages as seen here and alos overload the getMessages method to grab only new messages

Parameters:

message -

Throws:

MessagingException

getNextMessage

protected Message getNextMessage(Folder folder)
                          throws MessagingException

Throws:

MessagingException

getMessageCount

protected int getMessageCount(Folder folder)
                       throws MessagingException

Throws:

MessagingException

hasMessages

protected boolean hasMessages(Folder folder)
                       throws MessagingException

Optimised check to se whether to return the message count and retrieve the messages. Some pop3 implementations differ so an optimised check such as folder.hasNewMessages() cannot be used

Parameters:

folder -

Returns:

Throws:

MessagingException

getDelegateSession

public Object getDelegateSession()
                          throws org.mule.umo.UMOException

Throws:

org.mule.umo.UMOException

getConnector

public org.mule.umo.provider.UMOConnector getConnector()

doDispose

protected void doDispose()