org.mule.providers.email
Class MailConnector

java.lang.Object
  extended byorg.mule.providers.AbstractConnector
      extended byorg.mule.providers.email.MailConnector
All Implemented Interfaces:
Disposable, java.beans.ExceptionListener, Initialisable, Startable, Stoppable, UMOConnector

public class MailConnector
extends AbstractConnector

MailConnector A delegate endpoint that encapsulates

a pop3 and smtp endpoint for convenience

Version:
$Revision: 1.1.1.1 $
Author:
Ross Mason

Field Summary
 
Fields inherited from class org.mule.providers.AbstractConnector
DEFAULT_RETRY_COUNT, DEFAULT_RETRY_FREQUENCY, defaultInboundTransformer, defaultOutboundTransformer, defaultResponseTransformer, dispatcherFactory, dispatchers, disposed, exceptionStrategy, initialised, logger, name, receivers, started
 
Constructor Summary
MailConnector()
          Creates a new instance of MailConnector
 
Method Summary
 UMOMessageReceiver createReceiver(UMOComponent component, UMOEndpoint endpoint)
           
 void destroyReceiver(UMOMessageReceiver receiver, UMOEndpoint endpoint)
           
protected  void disposeConnector()
          Template method to perform any work when destroying the connectoe
 void doInitialise()
           
 java.lang.String getBccAddresses()
           
 java.lang.String getCcAddresses()
           
 long getCheckFrequency()
           
 java.lang.String getFromAddress()
           
 java.lang.String getMailbox()
          Getter for property hostname.
 UMOMessageAdapter getMessageAdapter(java.lang.Object message)
          Gets a UMOMessageAdapter for the endpoint for the given message (data)
protected  Pop3Connector getPop3Connector()
           
 java.lang.String getPop3Hostname()
          Getter for property hostname of the pop3 server.
 java.lang.String getPop3Password()
          Getter for property password.
 int getPop3Port()
           
 java.lang.Object getPop3Session()
           
 java.lang.String getPop3Username()
           
 java.lang.String getProtocol()
           
protected  SmtpConnector getSmtpConnector()
           
 java.lang.String getSmtpHostname()
          Getter for property hostname of the smtp server.
 java.lang.String getSmtpPassword()
          Getter for property password.
 int getSmtpPort()
           
 java.lang.Object getSmtpSession()
           
 java.lang.String getSmtpUsername()
          Getter for property username.
 java.lang.String getSubject()
           
 UMOMessage send(UMOEvent event)
           
 void setBccAddresses(java.lang.String bcc)
           
 void setCcAddresses(java.lang.String cc)
           
 void setCheckFrequency(long l)
           
 void setFromAddress(java.lang.String from)
           
 void setPop3Hostname(java.lang.String hostname)
          Setter for property hostname of the pop3 server.
 void setPop3Password(java.lang.String password)
          Setter for property password.
 void setPop3Port(int port)
           
 void setPop3Username(java.lang.String username)
          Setter for property username.
 void setSmtpHostname(java.lang.String hostname)
          Setter for property hostname of the smtp server.
 void setSmtpPassword(java.lang.String password)
          Setter for property password.
 void setSmtpPort(int port)
           
 void setSmtpUsername(java.lang.String user)
           
 void setSubject(java.lang.String subject)
           
 void startConnector()
          Template method to perform any work when starting the connectoe
 void stopConnector()
          Template method to perform any work when stopping the connectoe
 
Methods inherited from class org.mule.providers.AbstractConnector
createDispatcher, dispose, exceptionThrown, getDefaultInboundTransformer, getDefaultOutboundTransformer, getDefaultResponseTransformer, getDispatcher, getDispatcherFactory, getDispatcherThreadingProfile, getExceptionStrategy, getName, getReceiverKey, getReceiverThreadingProfile, getReplyToHandler, getRetryCount, getRetryFrequency, handleException, initialise, isDisposed, isDisposeDispatcherOnCompletion, isStarted, registerListener, setDefaultInboundTransformer, setDefaultOutboundTransformer, setDefaultResponseTransformer, setDispatcherFactory, setDispatcherThreadingProfile, setDisposeDispatcherOnCompletion, setExceptionStrategy, setName, setReceiverThreadingProfile, setRetryCount, setRetryFrequency, start, stop, unregisterListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MailConnector

public MailConnector()
              throws java.lang.Exception
Creates a new instance of MailConnector

Method Detail

doInitialise

public void doInitialise()
                  throws InitialisationException
Overrides:
doInitialise in class AbstractConnector
Throws:
InitialisationException

getCheckFrequency

public long getCheckFrequency()
Returns:

getFromAddress

public java.lang.String getFromAddress()
Returns:

getMailbox

public java.lang.String getMailbox()
Getter for property hostname.

Returns:
Value of property hostname.

getMessageAdapter

public UMOMessageAdapter getMessageAdapter(java.lang.Object message)
                                    throws MessageException
Description copied from interface: UMOConnector
Gets a UMOMessageAdapter for the endpoint for the given message (data)

Parameters:
message - the data with which to initialise the UMOMessageAdapter
Returns:
the UMOMessageAdapter for the endpoint
Throws:
MessageException - if the message parameter is not supported
See Also:
UMOMessageAdapter

getSmtpPassword

public java.lang.String getSmtpPassword()
Getter for property password.

Returns:
Value of property password.

getPop3Password

public java.lang.String getPop3Password()
Getter for property password.

Returns:
Value of property password.

getPop3Hostname

public java.lang.String getPop3Hostname()
Getter for property hostname of the pop3 server.

Returns:
Value of property hostname.

getSmtpHostname

public java.lang.String getSmtpHostname()
Getter for property hostname of the smtp server.

Returns:
Value of property hostname.

getProtocol

public java.lang.String getProtocol()
Specified by:
getProtocol in interface UMOConnector
Specified by:
getProtocol in class AbstractConnector

getPop3Session

public java.lang.Object getPop3Session()
                                throws UMOException
Throws:
UMOException

getSmtpSession

public java.lang.Object getSmtpSession()
                                throws UMOException
Throws:
UMOException

getSmtpUsername

public java.lang.String getSmtpUsername()
Getter for property username.

Returns:
Value of property username.

getPop3Username

public java.lang.String getPop3Username()

getPop3Port

public int getPop3Port()

getSmtpPort

public int getSmtpPort()

createReceiver

public UMOMessageReceiver createReceiver(UMOComponent component,
                                         UMOEndpoint endpoint)
                                  throws java.lang.Exception
Specified by:
createReceiver in class AbstractConnector
Throws:
java.lang.Exception

destroyReceiver

public void destroyReceiver(UMOMessageReceiver receiver,
                            UMOEndpoint endpoint)
                     throws java.lang.Exception
Overrides:
destroyReceiver in class AbstractConnector
Throws:
java.lang.Exception

send

public UMOMessage send(UMOEvent event)
                throws java.lang.Exception
Throws:
java.lang.Exception

setCheckFrequency

public void setCheckFrequency(long l)
Parameters:
l -

setFromAddress

public void setFromAddress(java.lang.String from)
Parameters:
from -

setPop3Port

public void setPop3Port(int port)

setSmtpPort

public void setSmtpPort(int port)

setPop3Password

public void setPop3Password(java.lang.String password)
Setter for property password.

Parameters:
password - New value of property password.

setSmtpPassword

public void setSmtpPassword(java.lang.String password)
Setter for property password.

Parameters:
password - New value of property password.

setPop3Hostname

public void setPop3Hostname(java.lang.String hostname)
Setter for property hostname of the pop3 server.

Parameters:
hostname - New value of property hostname.

setSmtpHostname

public void setSmtpHostname(java.lang.String hostname)
Setter for property hostname of the smtp server.

Parameters:
hostname - New value of property hostname.

setPop3Username

public void setPop3Username(java.lang.String username)
Setter for property username.

Parameters:
username - New value of property username.

startConnector

public void startConnector()
                    throws UMOException
Description copied from class: AbstractConnector
Template method to perform any work when starting the connectoe

Overrides:
startConnector in class AbstractConnector
Throws:
UMOException - if the method fails

stopConnector

public void stopConnector()
                   throws UMOException
Description copied from class: AbstractConnector
Template method to perform any work when stopping the connectoe

Overrides:
stopConnector in class AbstractConnector
Throws:
UMOException - if the method fails

setSmtpUsername

public void setSmtpUsername(java.lang.String user)
Parameters:
user -

disposeConnector

protected void disposeConnector()
                         throws UMOException
Description copied from class: AbstractConnector
Template method to perform any work when destroying the connectoe

Overrides:
disposeConnector in class AbstractConnector
Throws:
UMOException - if the method fails

getBccAddresses

public java.lang.String getBccAddresses()
Returns:

getCcAddresses

public java.lang.String getCcAddresses()
Returns:

getSubject

public java.lang.String getSubject()
Returns:

setBccAddresses

public void setBccAddresses(java.lang.String bcc)
Parameters:
bcc -

setCcAddresses

public void setCcAddresses(java.lang.String cc)
Parameters:
cc -

setSubject

public void setSubject(java.lang.String subject)
Parameters:
subject -

getPop3Connector

protected Pop3Connector getPop3Connector()
Returns:
Returns the pop3Connector.

getSmtpConnector

protected SmtpConnector getSmtpConnector()
Returns:
Returns the smtpConnector.


Copyright © 2003-2005 SymphonySoft Limited. All Rights Reserved.