org.torweg.pulse.configuration
Class EmailConfiguration

java.lang.Object
  org.torweg.pulse.configuration.EmailConfiguration

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CMSFormProcessorMailTaskConfiguration.MailCaseEmailConfiguration

public class EmailConfiguration
extends java.lang.Object
implements java.io.Serializable

A configuration for an email.

Version:

$Revision: 1387 $

Author:

Thomas Weber, Christian Schatt

See Also:

Serialized Form

Constructor Summary

protected	EmailConfiguration() The default constructor.
	EmailConfiguration(java.util.Collection<? extends EmailAddressConfiguration> to, java.util.Collection<? extends EmailAddressConfiguration> from, java.lang.String s, XSLHandleConfiguration t, XSLHandleConfiguration h) The constructor that sets the recipients, the senders, the subject, the XSLHandleConfiguration for the text part and the XSLHandleConfiguration for the HTML part.

Method Summary

void	clearRecipients() Clears any recipients.
XSLHandleConfiguration	getHtml() Returns the XSLHandleConfiguration for the HTML part.
java.util.Collection<EmailAddressConfiguration>	getRecipients() Returns the recipients as an unmodifiable Collection.
java.util.Collection<EmailAddressConfiguration>	getSenders() Returns the senders as an unmodifiable Collection.
java.lang.String	getSubject() Returns the subject.
XSLHandleConfiguration	getText() Returns the XSLHandleConfiguration for the text part.
protected void	setHtml(XSLHandleConfiguration h) Sets the XSLHandleConfiguration for the HTML part.
protected void	setRecipients(java.util.Collection<? extends EmailAddressConfiguration> to) Sets the recipients.
protected void	setSenders(java.util.Collection<? extends EmailAddressConfiguration> from) Sets the senders.
protected void	setSubject(java.lang.String s) Sets the subject.
protected void	setText(XSLHandleConfiguration t) Sets the XSLHandleConfiguration for the text part.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailConfiguration

protected EmailConfiguration()

The default constructor.

EmailConfiguration

public EmailConfiguration(java.util.Collection<? extends EmailAddressConfiguration> to,
                          java.util.Collection<? extends EmailAddressConfiguration> from,
                          java.lang.String s, XSLHandleConfiguration t, XSLHandleConfiguration h)

The constructor that sets the recipients, the senders, the subject, the XSLHandleConfiguration for the text part and the XSLHandleConfiguration for the HTML part.

Parameters:

to - the recipients

from - the senders

s - the subject

t - the XSLHandleConfiguration for the text part

h - the XSLHandleConfiguration for the HTML part

Method Detail

getRecipients

public final java.util.Collection<EmailAddressConfiguration> getRecipients()

Returns the recipients as an unmodifiable Collection.

Returns:

an unmodifiable view of the recipients

setRecipients

protected final void setRecipients(java.util.Collection<? extends EmailAddressConfiguration> to)

Sets the recipients.

Parameters:

to - the recipients to set.

clearRecipients

public final void clearRecipients()

Clears any recipients.

getSenders

public final java.util.Collection<EmailAddressConfiguration> getSenders()

Returns the senders as an unmodifiable Collection.

Returns:

an unmodifiable view of the senders

setSenders

protected final void setSenders(java.util.Collection<? extends EmailAddressConfiguration> from)

Sets the senders.

Parameters:

from - the senders to set.

getSubject

public final java.lang.String getSubject()

Returns the subject.

Returns:

the subject

setSubject

protected final void setSubject(java.lang.String s)

Sets the subject.

Parameters:

s - the subject to set

getText

public final XSLHandleConfiguration getText()

Returns the XSLHandleConfiguration for the text part.

Returns:

the XSLHandleConfiguration

setText

protected final void setText(XSLHandleConfiguration t)

Sets the XSLHandleConfiguration for the text part.

Parameters:

t - the XSLHandleConfiguration to set

getHtml

public final XSLHandleConfiguration getHtml()

Returns the XSLHandleConfiguration for the HTML part.

Returns:

the XSLHandleConfiguration

setHtml

protected final void setHtml(XSLHandleConfiguration h)

Sets the XSLHandleConfiguration for the HTML part.

Parameters:

h - the XSLHandleConfiguration to set