Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.mule.providers.mail
Class MailConnector  view MailConnector download MailConnector.java

java.lang.Object
  extended byorg.mule.providers.AbstractConnector
      extended byorg.mule.providers.mail.MailConnector
All Implemented Interfaces:
org.mule.util.ExceptionListener, org.mule.umo.provider.UMOConnector

public class MailConnector
extends org.mule.providers.AbstractConnector

MailConnector A delegate connector that encapsulates a pop3 and smtp connector for convenience

Version:
$Revision: 1.6 $

Field Summary
private static org.apache.commons.logging.Log log
          logger used by this class
private  Pop3Connector pop3Connector
           
private  SmtpConnector smtpConnector
           
 
Fields inherited from class org.mule.providers.AbstractConnector
alive, DO_THREADING_PROPERTY, doThreading, exceptionStrategy, name, properties, protocol, started, transportName
 
Constructor Summary
MailConnector()
          Creates a new instance of MailConnector
 
Method Summary
 void create()
          A template method to perform any additional creating work by the deriving class
 java.lang.Object createMessage(java.lang.Object message)
           
protected  javax.mail.Message createMessage(java.lang.String from, java.lang.String to, java.lang.String cc, java.lang.String bcc, java.lang.String subject, java.lang.String body)
           
protected  javax.mail.Session createSession(javax.mail.URLName url)
           
 void dispatch(org.mule.umo.UMOEvent event)
          Dispatches an event from the connector to the external system
 java.lang.String getBcc()
           
 java.lang.String getCc()
           
 long getCheckFrequency()
           
 java.lang.String getDefaultSubject()
           
 java.lang.String getFrom()
           
 java.lang.String getMailbox()
          Getter for property hostname.
 org.mule.umo.provider.UMOMessageAdapter getMessageAdapter(java.lang.Object message)
          Gets a UMOMessageAdapter for the connector for the given message (data)
 java.lang.String getPOP3Hostname()
          Getter for property hostname of the pop3 server.
 java.lang.String getPop3Password()
          Getter for property password.
 java.lang.Object getPop3Session()
           
 java.lang.String getPop3Username()
           
 java.lang.String getProtocol()
           
 java.lang.String getSmtpHostname()
          Getter for property hostname of the smtp server.
 java.lang.String getSmtpPassword()
          Getter for property password.
 java.lang.Object getSmtpSession()
           
 java.lang.String getSmtpUsername()
          Getter for property username.
 void registerListener(org.mule.umo.UMOSession session, org.mule.umo.UMOProviderDescriptor provider)
          This creates a UMOMessageReceiver associated with this connector and registers it with the connector
 void removeListener(org.mule.umo.UMOSession session, org.mule.umo.UMOProviderDescriptor provider)
           
 org.mule.umo.UMOEvent send(org.mule.umo.UMOEvent event)
          Sends an event from the connector to the external system
 void setBcc(java.lang.String bcc)
           
 void setCc(java.lang.String cc)
           
 void setCheckFrequency(long l)
           
 void setDefaultSubject(java.lang.String subject)
           
 void setFrom(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 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 setSmtpUsername(java.lang.String user)
           
protected  void shutdownConnector()
          Template method to perform any work when destroying the connectoe
 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
create, dispatch, getExceptionStrategy, getName, getProperties, getProperty, getProperty, getSession, getTransportName, handleException, isAlive, isDoThreading, isStarted, onException, setDoThreading, setExceptionStrategy, setName, setProperties, setProperty, setProtocol, setTransportName, shutdown, start, stop
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

private static transient org.apache.commons.logging.Log log
logger used by this class


pop3Connector

private Pop3Connector pop3Connector

smtpConnector

private SmtpConnector smtpConnector
Constructor Detail

MailConnector

public MailConnector()
Creates a new instance of MailConnector

Method Detail

create

public void create()
            throws java.lang.Exception
Description copied from class: org.mule.providers.AbstractConnector
A template method to perform any additional creating work by the deriving class


createSession

protected javax.mail.Session createSession(javax.mail.URLName url)

createMessage

public java.lang.Object createMessage(java.lang.Object message)
                               throws java.lang.Exception

createMessage

protected javax.mail.Message createMessage(java.lang.String from,
                                           java.lang.String to,
                                           java.lang.String cc,
                                           java.lang.String bcc,
                                           java.lang.String subject,
                                           java.lang.String body)
                                    throws org.mule.MuleException

dispatch

public void dispatch(org.mule.umo.UMOEvent event)
              throws java.lang.Exception
Description copied from interface: org.mule.umo.provider.UMOConnector
Dispatches an event from the connector to the external system


getCheckFrequency

public long getCheckFrequency()

getFrom

public java.lang.String getFrom()

getMailbox

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


getMessageAdapter

public org.mule.umo.provider.UMOMessageAdapter getMessageAdapter(java.lang.Object message)
                                                          throws java.lang.Exception
Description copied from interface: org.mule.umo.provider.UMOConnector
Gets a UMOMessageAdapter for the connector for the given message (data)


getSmtpPassword

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


getPop3Password

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


getPOP3Hostname

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


getSmtpHostname

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


getProtocol

public java.lang.String getProtocol()

getPop3Session

public java.lang.Object getPop3Session()

getSmtpSession

public java.lang.Object getSmtpSession()

getSmtpUsername

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


getPop3Username

public java.lang.String getPop3Username()

registerListener

public void registerListener(org.mule.umo.UMOSession session,
                             org.mule.umo.UMOProviderDescriptor provider)
                      throws java.lang.Exception
Description copied from interface: org.mule.umo.provider.UMOConnector
This creates a UMOMessageReceiver associated with this connector and registers it with the connector


removeListener

public void removeListener(org.mule.umo.UMOSession session,
                           org.mule.umo.UMOProviderDescriptor provider)
                    throws java.lang.Exception

send

public org.mule.umo.UMOEvent send(org.mule.umo.UMOEvent event)
                           throws java.lang.Exception
Description copied from interface: org.mule.umo.provider.UMOConnector
Sends an event from the connector to the external system


setCheckFrequency

public void setCheckFrequency(long l)

setFrom

public void setFrom(java.lang.String from)

setPop3Password

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


setSmtpPassword

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


setPOP3Hostname

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


setSmtpHostname

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


setPop3Username

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


startConnector

public void startConnector()
                    throws java.lang.Exception
Description copied from class: org.mule.providers.AbstractConnector
Template method to perform any work when starting the connectoe


stopConnector

public void stopConnector()
                   throws java.lang.Exception
Description copied from class: org.mule.providers.AbstractConnector
Template method to perform any work when stopping the connectoe


setSmtpUsername

public void setSmtpUsername(java.lang.String user)

shutdownConnector

protected void shutdownConnector()
                          throws java.lang.Exception
Description copied from class: org.mule.providers.AbstractConnector
Template method to perform any work when destroying the connectoe


getBcc

public java.lang.String getBcc()

getCc

public java.lang.String getCc()

getDefaultSubject

public java.lang.String getDefaultSubject()

setBcc

public void setBcc(java.lang.String bcc)

setCc

public void setCc(java.lang.String cc)

setDefaultSubject

public void setDefaultSubject(java.lang.String subject)