This project has retired. For details please refer to its Attic page.

org.apache.lenya.cms.mail
Class MailTask

java.lang.Object
  org.apache.lenya.cms.task.AbstractTask
      org.apache.lenya.cms.mail.MailTask

All Implemented Interfaces:

org.apache.avalon.framework.parameters.Parameterizable, Task

public class MailTask
extends AbstractTask

A task that sends an e-mail. Each parameter can either be provided as a task parameter or extracted from an XML document. If the parameter "uri" starts with a http:// or ftp:// prefix, the absolute URI is used. If not, the URI is interpreted as relative to the local publication.

The task parameters are:
uri: the URI to get the XML file from
server: the SMTP server
from:
to:
cc:
bcc:
subject:
body:

All parameters are optional. If the uri parameter is provided, the document is fetched from the URI and the parameters are extracted. Task parameters have a higher priority than elements of the document.

The document has the following form:

<mail:mail xmlns:mail="http://apache.org/cocoon/lenya/mail/1.0">
<mail:server>mail.yourhost.com</mail:server>
...
</mail:mail>


Field Summary

static java.lang.String	ELEMENT_BCC
static java.lang.String	ELEMENT_BODY
static java.lang.String	ELEMENT_CC
static java.lang.String	ELEMENT_FROM
static java.lang.String	ELEMENT_SERVER
static java.lang.String	ELEMENT_SUBJECT
static java.lang.String	ELEMENT_TO
static java.lang.String	NAMESPACE_URI
static java.lang.String	PARAMETER_URI

Fields inherited from interface org.apache.lenya.cms.task.Task

DEFAULT_PREFIX, FAILURE, NAMESPACE, PARAMETER_CONTEXT_PREFIX, PARAMETER_PUBLICATION_ID, PARAMETER_SERVER_PORT, PARAMETER_SERVER_URI, PARAMETER_SERVLET_CONTEXT, SUCCESS

Constructor Summary

MailTask()

Method Summary

void	execute(java.lang.String contextPath) DOCUMENT ME!
void	sendMail(java.lang.String host, java.lang.String from, java.lang.String to, java.lang.String cc, java.lang.String bcc, java.lang.String subject, java.lang.String body) DOCUMENT ME!

Methods inherited from class org.apache.lenya.cms.task.AbstractTask

getParameters, getResult, parameterize, setLabel, setResult

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT_TO

public static final java.lang.String ELEMENT_TO

See Also:

Constant Field Values

ELEMENT_CC

public static final java.lang.String ELEMENT_CC

See Also:

Constant Field Values

ELEMENT_BCC

public static final java.lang.String ELEMENT_BCC

See Also:

Constant Field Values

ELEMENT_SUBJECT

public static final java.lang.String ELEMENT_SUBJECT

See Also:

Constant Field Values

ELEMENT_BODY

public static final java.lang.String ELEMENT_BODY

See Also:

Constant Field Values

ELEMENT_FROM

public static final java.lang.String ELEMENT_FROM

See Also:

Constant Field Values

ELEMENT_SERVER

public static final java.lang.String ELEMENT_SERVER

See Also:

Constant Field Values

PARAMETER_URI

public static final java.lang.String PARAMETER_URI

See Also:

Constant Field Values

NAMESPACE_URI

public static final java.lang.String NAMESPACE_URI

See Also:

Constant Field Values

Constructor Detail

MailTask

public MailTask()

Method Detail

execute

public void execute(java.lang.String contextPath)

DOCUMENT ME!

Parameters:

contextPath - DOCUMENT ME!

sendMail

public void sendMail(java.lang.String host,
                     java.lang.String from,
                     java.lang.String to,
                     java.lang.String cc,
                     java.lang.String bcc,
                     java.lang.String subject,
                     java.lang.String body)

DOCUMENT ME!

Parameters:

host - DOCUMENT ME!

from - DOCUMENT ME!

to - DOCUMENT ME!

cc - DOCUMENT ME!

bcc - DOCUMENT ME!

subject - DOCUMENT ME!

body - DOCUMENT ME!