com.opensymphony.workflow.util
Class SendEmail
java.lang.Object
com.opensymphony.workflow.util.SendEmail
- All Implemented Interfaces:
- FunctionProvider
public class SendEmail
- extends Object
- implements FunctionProvider
Sends an email to a group of users. The following arguments are expected:
- to - comma seperated list of email addresses
- from - single email address
- subject - the message subject
- cc - comma seperated list of email addresses (optional)
- message - the message body
- smtpHost - the SMTP host that will relay the message
- parseVariables - if 'true', then variables of the form ${} in subject,
message, to, and cc fields will be parsed
- Author:
- Pat Lightbody
|
Method Summary |
void |
execute(Map transientVars,
Map args,
com.opensymphony.module.propertyset.PropertySet ps)
Execute this function |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
SendEmail
public SendEmail()
execute
public void execute(Map transientVars,
Map args,
com.opensymphony.module.propertyset.PropertySet ps)
- Description copied from interface:
FunctionProvider
- Execute this function
- Specified by:
execute in interface FunctionProvider
- Parameters:
transientVars - Variables that will not be persisted. These include inputs
given in the Workflow.initialize(java.lang.String, int, java.util.Map) and Workflow.doAction(long, int, java.util.Map) method calls.
There are a number of special variable names:
entry: (object type: WorkflowEntry)
The workflow instance
context:
(object type: WorkflowContext). The workflow context.
actionId: The Integer ID of the current action that was take (if applicable).
currentSteps: A Collection of the current steps in the workflow instance.
store: The WorkflowStore.
descriptor: The WorkflowDescriptor.
Also, any variable set as a Register), will also be
available in the transient map, no matter what. These transient variables only last through
the method call that they were invoked in, such as Workflow.initialize(java.lang.String, int, java.util.Map)
and Workflow.doAction(long, int, java.util.Map).args - The properties for this function invocation. Properties are created
from arg nested elements within the xml, an arg element takes in a name attribute
which is the properties key, and the CDATA text contents of the element map to
the property value.ps - The persistent variables that are associated with the current
instance of the workflow. Any change made to the propertyset are persisted to
the propertyset implementation's persistent store.