oracle.mail.sdk.rule
Class CommandType

java.lang.Object
  |
  +--oracle.xml.classgen.CGXSDElement
        |
        +--oracle.mail.sdk.rule.RuleElement
              |
              +--oracle.mail.sdk.rule.CommandType

public class CommandType

extends RuleElement

The class represents a command name, as part of an action object. There are following choices of commands:

• pass: don't do anything. Requires no parameters.
• reject: reject the message upon reception. This action can only be used by the server. Requires one parameter to specify a reason string to be used in the rejection mail message.
• discard: delete the current message. Requires no parameters.
• forward: forward the message to a new recipient. Requires 3 parameters: the recipient address, the subject line and a message template to be used to generate forward comments.
• bcc: blind copy to another recipient. Requires a parameter to specify the new recipient.
• moveto: move the current message to another folder. Requires one parameter to contain the new folder name.
• copyto: copy the current message to another folder. Requires one parameter to contain the new folder name.
• setprop: set message flags and properties. Requires two paramters, the property name and the property value. The list of property names are:
  • SEEN: whether the message is read. Values can be ON or OFF.
  • DELETED: whether the message is marked deleted. Values can be ON or OFF.
  • FLAGGED: whether the message is marked with a flag. Values can be ON or OFF.
  • ANSWERED: whether the message has been replied. Values can be ON or OFF.
  • DRAFT: whether the message can be used as a draft message. Values can be ON or OFF.
  • EXPIRY: when should the message expire and be removed from the system. Value should be number of days before the message should expire.
• notify: notify a recipient without attaching the current message. Requires 3 parameters: the recipient address, the subject line and a message template used to generate the notification message body.
• reply: reply back to sender. Requires 3 parameters: the effective duration of this reply, the subject line and the message template.
• replyall: reply back to sender and all other recipients of this message. Requires 3 parameters: the effective duration of this reply, the subject line and the message template.
• break: stop further rule processing. Requires no parameters.
• call: invoke a custom PL/SQL procedure. Requires 3 parameters: the procedure name and two user-defined procedure parameters.

Since:

9.0

Version:

$Header: CommandType.java 01-may-2003.16:44:10 haye Exp $

Constructor Summary

CommandType()

Method Summary

java.lang.String

getTag() Gets the command name

Methods inherited from class oracle.mail.sdk.rule.RuleElement

getParent, getType, printAttributes, removeAll, removeAt

Methods inherited from class oracle.xml.classgen.CGXSDElement

getAttributes, getChildElements, getNodeValue, print, printAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandType

public CommandType()

Method Detail

getTag

public java.lang.String getTag()

Gets the command name

Returns:

command name