oracle.mail.sdk.rule
Class AttributeType

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

public class AttributeType

extends RuleElement

The class represents a message attribute, to be used in a condition object. Some attributes requires parameters, such as "xheader" requiring a header name, and "flag" requiring a flag name. The choices to attribute tag names are:

• rfc822from: the "From:" header value of a message.
• rfc822to: the "To:" header value of a message.
• rfc822cc: the "Cc:" header value of a message.
• rfc822subject: the "Subject:" header value of a message.
• rfc822replyto: the "Reply-To:" header value of a message.
• rfc822date: the "Date:" header value of a message translated into a date (instead of a string value).
• message_id: the "Message-Id:" header value of a message.
• contenttype: the first "Content-Type:" header value of a message, excluding the same headers for attachments.
• charset: the part of "Content-Type:" header that indicates the character set encoding information.
• xpriority: the "X-Priority:" header value of a message.
• xheader: any other user-defined message header, requires a parameter to specify the header name.
• messagesize: message size in number of bytes.
• receiveddate: the received date of a message.
• folder: the folder name that the current message resides in.
• flag: the flag value on the current message, requires a parameter indicating the flag name. Flag names can be "SEEN", "DELETED", "FLAGGED", "DRAFT" or "ANSWERED". The flags values are either ON or OFF.
• rulestatus: the rule execution status of the last rule executed. This attribute only exists if you have another rule that executes an external Pl/SQL procedure immediately in front of this rule.

Since:

9.0

Version:

$Header: AttributeType.java 30-jun-2002.13:24:41 haye Exp $

See Also:

ConditionType

Constructor Summary

AttributeType(java.lang.String theattribute)
Creates an instance from an attribute string

Method Summary

java.lang.String	getAttributeType() Gets the attribute data type
java.lang.String	getParam() Gets the value of attribute parameter
java.lang.String	getTag() Gets the attribute name
void	setParam(java.lang.String theparam) Sets the value of the attribute parameter

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

AttributeType

public AttributeType(java.lang.String theattribute)
              throws oracle.xml.classgen.InvalidContentException

Creates an instance from an attribute string

Parameters:

theattribute - the attribute string

Throws:

oracle.xml.classgen.InvalidContentException - if the attribute string is not valid

Method Detail

getTag

public java.lang.String getTag()

Gets the attribute name

Returns:

name of the attribute

getAttributeType

public java.lang.String getAttributeType()

Gets the attribute data type

Returns:

data type of the attribute

setParam

public void setParam(java.lang.String theparam)
              throws java.lang.IllegalArgumentException

Sets the value of the attribute parameter

Parameters:

theparam - the parameter to set

Throws:

java.lang.IllegalArgumentException - if the attribute is not valid.

getParam

public java.lang.String getParam()
                          throws java.lang.IllegalArgumentException

Gets the value of attribute parameter

Returns:

the attrubute parameter

Throws:

java.lang.IllegalArgumentException - if the attribute is not valid.