Class JDPEmailSender

java.lang.Object
   |
   +----JDPEmailSender

public class JDPEmailSender
extends Object
Class JDPEmailSender represents an interface the the JaggServer email mechanism.


Constructor Index

 o JDPEmailSender(JDPUser)
Creates a Email sender.
 o JDPEmailSender(JDPUser, JDPJagg)
Creates a Email sender.

Method Index

 o sendMultipleMessage()
Send multiple messages.
 o sendSingleMessage()
Send a single message.
 o setAttachment(String)
Set the attachment file path.
 o setCSTR(String)
Set the database connection string for doing a merge.
 o setDSN(String)
Set the datasource/database name for doing a merge.
 o setFromWhereClause(String)
Set the where clause string for doing a merge.
 o setJdbcDriver(String)
Set the fully qualified class name of the JDBC driver.
 o setJdbcPrefix(String)
Set the prefix to use for connecting to the JDBC driver.
 o setJdbcSuffix(String)
Set the suffix to use for connecting to the JDBC driver.
 o setMailServer(String)
Set the name of the mail server.
 o setMergeColumns(String[])
Set the merge column names for doing a merge.
 o setMessage(String)
Set the message.
 o setMessageSubject(String)
Set the message subject.
 o setPWD(String)
Set the password string for doing a merge.
 o setReturnAddress(String)
Set the return address.
 o setSQL(String)
Set the SQL string for doing a merge.
 o setToAddress(String)
Set the to address.
 o setUID(String)
Set the userid string for doing a merge.

Constructors

 o JDPEmailSender
 public JDPEmailSender(JDPUser user)
Creates a Email sender.

Parameters:
JDPUser - the global user parameter used to pass handles in JDP.
 o JDPEmailSender
 public JDPEmailSender(JDPUser user,
                       JDPJagg jaggSQL)
Creates a Email sender.

Parameters:
JDPUser - the global user parameter used to pass handles in JDP.
JDPJagg - instance for email merge with a database.

Methods

 o setMailServer
 public void setMailServer(String mailServer)
Set the name of the mail server.

Parameters:
mailServer - the name of the mail server.
 o setReturnAddress
 public void setReturnAddress(String returnAddress)
Set the return address.

Parameters:
returnAddress - the return address.
 o setMessageSubject
 public void setMessageSubject(String messageSubject)
Set the message subject.

Parameters:
messageSubject - the message subject.
 o setMessage
 public void setMessage(String message)
Set the message. This is used for single messages or for message merging.

Parameters:
message - the message to send.
 o setToAddress
 public void setToAddress(String toAddress)
Set the to address. This is only used for single messages.

Parameters:
toAddress - the to address of the message.
 o setAttachment
 public void setAttachment(String attachment)
Set the attachment file path. This is only used for single messages.

Parameters:
attachment - the path and file name on the server to the attachment.
 o setDSN
 public void setDSN(String DSN)
Set the datasource/database name for doing a merge.

Parameters:
DSN - the datasource/database name for JDPJagg to use.
 o setJdbcDriver
 public void setJdbcDriver(String jdbcDriver)
Set the fully qualified class name of the JDBC driver.

Parameters:
jcbdDriver - the fully qualified class name of the JDBC driver.
 o setJdbcPrefix
 public void setJdbcPrefix(String jdbcPrefix)
Set the prefix to use for connecting to the JDBC driver.

Parameters:
jcbdPrefix - the prefix to use for connecting to the JDBC driver.
 o setJdbcSuffix
 public void setJdbcSuffix(String jdbcSuffix)
Set the suffix to use for connecting to the JDBC driver.

Parameters:
jcbdSuffix - the suffix to use for connecting to the JDBC driver.
 o setUID
 public void setUID(String UID)
Set the userid string for doing a merge.

Parameters:
UID - the userid for JDPJagg to use.
 o setPWD
 public void setPWD(String PWD)
Set the password string for doing a merge.

Parameters:
PWD - the password for JDPJagg to use.
 o setCSTR
 public void setCSTR(String CSTR)
Set the database connection string for doing a merge.

Parameters:
CSTR - the connection string for JDPJagg to use. This will typically be of the form DSN=MyDatabase;UID=myuser;PWD=mypassword;
 o setSQL
 public void setSQL(String SQL)
Set the SQL string for doing a merge. See the generated code for the alpha merge data bound component for an example of a valid SQL.

Parameters:
SQL - the SQL for JDPJagg to use.
 o setFromWhereClause
 public void setFromWhereClause(String whereClause)
Set the where clause string for doing a merge. See the generated code for the alpha merge data bound component for an example of a valid where clause.

Parameters:
whereClause - the where clause for JDPJagg to use.
 o setMergeColumns
 public void setMergeColumns(String columns[])
Set the merge column names for doing a merge. See the generated code for the alpha merge data bound component for an example of a valid where clause.

Parameters:
columns - the names of the columns from the selected SQL that will be used for the merge.
 o sendSingleMessage
 public void sendSingleMessage()
Send a single message. If the mailServer, fromAddress, messageSubject, toAddress and message have all been set then this method is used to send the message.

 o sendMultipleMessage
 public void sendMultipleMessage()
Send multiple messages. This method is used in conjunction with the database merging methods to tell JaggServer to run the SQL, do the merge with the resulting rows and send the messages that are created as a result of the merge.