Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> mule >> providers >> [ mail overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.mule.providers.mail
Class SmtpConnector  

java.lang.Object
  org.mule.providers.AbstractConnector
      org.mule.providers.mail.SmtpConnector

All Implemented Interfaces:

org.mule.util.ExceptionListener, org.mule.umo.provider.UMOConnector

---

public class SmtpConnector

extends org.mule.providers.AbstractConnector

SmtpConnector is used to connect to and send data to an SMTP mail server

Version:

$Revision: 1.4 $

---

Nested Class Summary
private  class	SmtpConnector.MailDispatcher

 

Field Summary
private  java.lang.String	bcc           Holds value of bcc addresses.
private  java.lang.String	cc           Holds value of cc addresses.
private  boolean	connected           determines whether a mailbox connection is active
private  boolean	credentialsChanged           detemines whether login credentials have changed
private  java.lang.String	defaultSubject           Holds value of default subject
private  java.lang.String	from           Holds value of the from address.
private  java.lang.String	hostname           Holds value of property hostname for the smtp server.
private static org.apache.commons.logging.Log	log           logger used by this class
private  java.lang.String	password           Holds value of property SMTP password.
private  javax.mail.Session	session
private  javax.mail.URLName	url           Mail Send connection url
private  java.lang.String	username           Holds value of property SMTPusername.

 

Fields inherited from class org.mule.providers.AbstractConnector

alive, DO_THREADING_PROPERTY, doThreading, exceptionStrategy, name, properties, protocol, started, transportName

 

Constructor Summary

SmtpConnector()           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()
java.lang.String	getDefaultSubject()
java.lang.String	getFrom()
java.lang.String	getHostname()
org.mule.umo.provider.UMOMessageAdapter	getMessageAdapter(java.lang.Object message)           Gets a UMOMessageAdapter for the connector for the given message (data)
java.lang.String	getPassword()
java.lang.String	getProtocol()
java.lang.Object	getSession()
java.lang.String	getSMTPHostname()           Getter for property hostname of the pop3 server.
java.lang.String	getUsername()
boolean	isConnected()
private  void	login()
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
protected  void	sendMailMessage(javax.mail.Message message)
protected  void	sendMailMessage(java.lang.String to, java.lang.String cc, java.lang.String bcc, java.lang.String subject, java.lang.String body)
void	setBcc(java.lang.String string)
void	setCc(java.lang.String string)
void	setDefaultSubject(java.lang.String string)
void	setFrom(java.lang.String string)
void	setHostname(java.lang.String string)
void	setPassword(java.lang.String string)
void	setUsername(java.lang.String string)
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, 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

---

bcc

private java.lang.String bcc

Holds value of bcc addresses.

---

cc

private java.lang.String cc

Holds value of cc addresses.

---

connected

private boolean connected

determines whether a mailbox connection is active

---

credentialsChanged

private boolean credentialsChanged

detemines whether login credentials have changed

---

defaultSubject

private java.lang.String defaultSubject

Holds value of default subject

---

from

private java.lang.String from

Holds value of the from address.

---

password

private java.lang.String password

Holds value of property SMTP password.

---

hostname

private java.lang.String hostname

Holds value of property hostname for the smtp server.

---

url

private javax.mail.URLName url

Mail Send connection url

---

username

private java.lang.String username

Holds value of property SMTPusername.

---

session

private javax.mail.Session session

Constructor Detail

SmtpConnector

public SmtpConnector()

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

---

getFrom

public java.lang.String getFrom()

---

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)

---

getProtocol

public java.lang.String getProtocol()

---

getSession

public java.lang.Object getSession()

---

getSMTPHostname

public java.lang.String getSMTPHostname()

Getter for property hostname of the pop3 server.

---

isConnected

public boolean isConnected()

---

login

private void login()
            throws javax.mail.NoSuchProviderException,
                   javax.mail.MessagingException

---

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

---

sendMailMessage

protected void sendMailMessage(javax.mail.Message message)
                        throws javax.mail.MessagingException

---

sendMailMessage

protected void sendMailMessage(java.lang.String to,
                               java.lang.String cc,
                               java.lang.String bcc,
                               java.lang.String subject,
                               java.lang.String body)
                        throws org.mule.MuleException

---

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

---

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()

---

getHostname

public java.lang.String getHostname()

---

getPassword

public java.lang.String getPassword()

---

getUsername

public java.lang.String getUsername()

---

setBcc

public void setBcc(java.lang.String string)

---

setCc

public void setCc(java.lang.String string)

---

setDefaultSubject

public void setDefaultSubject(java.lang.String string)

---

setFrom

public void setFrom(java.lang.String string)

---

setHostname

public void setHostname(java.lang.String string)

---

setPassword

public void setPassword(java.lang.String string)

---

setUsername

public void setUsername(java.lang.String string)

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> mule >> providers >> [ mail overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---