jhomenet.responsive.response
Class EmailResponse

java.lang.Object
  jhomenet.responsive.response.AbstractResponse
      jhomenet.responsive.response.EmailResponse

public class EmailResponse
extends AbstractResponse

Version:

$Revision: 1.9 $ Filename: $Source: /cvsroot/jhomenet/files/src/jhomenet/responsive/response/EmailResponse.java,v $ Description: This response will send out an email to the receipients when the response is executed.

Author:

$Author: dhirwinjr $

Field Summary

Fields inherited from class jhomenet.responsive.response.AbstractResponse

hasExecuted, id

Constructor Summary

EmailResponse()
Default constructor.

Method Summary

void	addCcrecipient(java.lang.String recipients) Add a CC email address.
void	addRecipient(java.lang.String recipients) Add an email address.
void	execute() Execute the response.
java.lang.String	getCcrecipients() Get the list of CC recipients.
java.lang.String	getHost() Get the email hostname.
java.lang.String	getMessage() Get the email message.
java.lang.String	getRecipients() Get a list of email recipients.
java.lang.String	getReplyto() Get the replyTo email address.
java.lang.String	getSender() Get the sender.
java.lang.String	getSubject() Get the email subject.
void	initialize() Initialize the email response with default values from a configuration file.
void	setCcrecipients(java.lang.String recipients) Set the list of CC email addresses.
void	setHost(java.lang.String host) Set the email hostname.
void	setMessage(java.lang.String message) Set the email message.
void	setRecipients(java.lang.String recipients) Set the list of email addresses.
void	setReplyto(java.lang.String replyTo) Set the reply-to email address.
void	setSender(java.lang.String sender) Set the sender.
void	setSubject(java.lang.String subject) Set the email subject.
java.lang.String	toString() Return a string representation of the email response.

Methods inherited from class jhomenet.responsive.response.AbstractResponse

formatToString, getId, getResponseDescription, hasExecuted, setId, setResponseDescription

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailResponse

public EmailResponse()

Default constructor.

Method Detail

initialize

public void initialize()

Initialize the email response with default values from a configuration file.

setHost

public void setHost(java.lang.String host)

Set the email hostname.

Parameters:

host -

getHost

public java.lang.String getHost()

Get the email hostname.

Returns:

The email hostname

setSubject

public void setSubject(java.lang.String subject)

Set the email subject.

Parameters:

subject -

getSubject

public java.lang.String getSubject()

Get the email subject.

Returns:

The email subject

setMessage

public void setMessage(java.lang.String message)

Set the email message.

Parameters:

message -

getMessage

public java.lang.String getMessage()

Get the email message.

Returns:

The email message

setRecipients

public void setRecipients(java.lang.String recipients)

Set the list of email addresses. Note: this method will overwrite the current list of email addresses.

Parameters:

recipients - Semi-colon separated list of recipients

addRecipient

public void addRecipient(java.lang.String recipients)

Add an email address.

Parameters:

recipients -

getRecipients

public java.lang.String getRecipients()

Get a list of email recipients.

Returns:

Semi-colon separated list of recipients

setCcrecipients

public void setCcrecipients(java.lang.String recipients)

Set the list of CC email addresses. Note: this method will overwrite the current list of CC email addresses.

Parameters:

recipients - Semi-colon separated list of CC recipients

addCcrecipient

public void addCcrecipient(java.lang.String recipients)

Add a CC email address.

Parameters:

recipients -

getCcrecipients

public java.lang.String getCcrecipients()

Get the list of CC recipients.

Returns:

A semi-colon separated list of CC recipients

setSender

public void setSender(java.lang.String sender)

Set the sender.

Parameters:

sender -

getSender

public java.lang.String getSender()

Get the sender.

Returns:

The sender

setReplyto

public void setReplyto(java.lang.String replyTo)

Set the reply-to email address.

Parameters:

replyTo -

getReplyto

public java.lang.String getReplyto()

Get the replyTo email address.

Returns:

The reply-to email address

execute

public void execute()
             throws ResponsiveException

Execute the response.

Specified by:

execute in class AbstractResponse

Throws:

ResponsiveException

See Also:

AbstractResponse.execute()

toString

public java.lang.String toString()

Return a string representation of the email response.

Specified by:

toString in class AbstractResponse

See Also:

Object.toString()