|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bea.campaign.action.Action com.bea.campaign.action.MailAction
public class MailAction
Action implementation to send email to a user. All params will be passed to the MailService. By default this will add the new message to a batch, but can also send messages immediately.
Field Summary | |
---|---|
static String |
BATCH_MODE
parameter key to flag batch-mode (defaults to true) |
static String |
CONTAINER_ID_JSP_PARAM
The name of the jsp parameter that will contain the current scenario container id. |
static String |
CONTAINER_NAME_JSP_PARAM
The name of the jsp parameter that will contain the current scenario container name. |
static String |
DEFAULT_FROM_ADDRESS_KEY
Deprecated No longer used. |
static String |
EMAIL_PROPERTY_NAME_KEY
Deprecated No longer used. |
static String |
EMAIL_PROPERTY_SET_KEY
Deprecated No longer used. |
static String |
FROM_PARAM
parameter key for the from address |
static String |
GLOBAL_BATCH
global batch name (if none is provided) |
static String |
JSP_PARAMS
parameter key for a map of JSP parameters to pass |
static String |
JSP_URI
parameter key for the URI of a JSP to use to generate the message |
static String |
MESSAGE_HEADERS
parameter key for a map of mail headers |
static String |
MESSAGE_TEXT_PARAM
parameter key for the message text |
static String |
OPT_IN_PROPERTY_NAME_KEY
Deprecated |
static String |
OPT_IN_PROPERTY_SET_KEY
Deprecated No longer used. |
static String |
SCENARIO_ID_JSP_PARAM
The name of the jsp parameter that will contain the current scenario id. |
static String |
SCENARIO_NAME_JSP_PARAM
The name of the jsp parameter that will contain the current scenario name. |
static String |
SUBJECT_PARAM
parameter key for the mail subject |
static String |
TO_PARAM
parameter key for the to address |
static String |
USER_ID_JSP_PARAM
The name of the jsp parameter that will contain the current user id. |
Constructor Summary | |
---|---|
MailAction()
|
Method Summary | |
---|---|
protected MailService |
getMailService()
|
void |
init(Map params)
Initialize the MailAction so that it can generate and batch a message. |
void |
run()
Run the Action; in this case, create an email based on the parameters received in the init() method. |
String |
toString()
|
Methods inherited from class com.bea.campaign.action.Action |
---|
getEvent, getRandom, getRequest, getScenario, getScenarioContainer, getScenarioContainerName, getScenarioId, getScenarioName, getServiceLocator, getSession, getTimestamp, getUser, getUserId, locateService, setEvent, setRandom, setRequest, setScenario, setScenarioContainer, setServiceLocator, setSession, setTimestamp, setUser |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String DEFAULT_FROM_ADDRESS_KEY
public static final String EMAIL_PROPERTY_NAME_KEY
public static final String EMAIL_PROPERTY_SET_KEY
public static final String OPT_IN_PROPERTY_SET_KEY
public static final String OPT_IN_PROPERTY_NAME_KEY
public static final String SUBJECT_PARAM
public static final String MESSAGE_TEXT_PARAM
public static final String FROM_PARAM
public static final String TO_PARAM
public static final String JSP_URI
public static final String JSP_PARAMS
public static final String MESSAGE_HEADERS
public static final String BATCH_MODE
public static final String GLOBAL_BATCH
public static final String USER_ID_JSP_PARAM
public static final String CONTAINER_ID_JSP_PARAM
public static final String CONTAINER_NAME_JSP_PARAM
public static final String SCENARIO_ID_JSP_PARAM
public static final String SCENARIO_NAME_JSP_PARAM
Constructor Detail |
---|
public MailAction()
Method Detail |
---|
public void run() throws ActionException
run
in class Action
ActionException
- will be thrown if an error occurspublic void init(Map params) throws IllegalArgumentException
Parameters are:
init
in class Action
params
- A map of name/value pairs
IllegalArgumentException
- if any required params are missingprotected MailService getMailService() throws Exception
Exception
public String toString()
toString
in class Object
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |