Rule.Modify

Modifies an existing rule.

Parameters

The following parameters are for all rules. A rule parameter might be required only if you are saving a specific rule type. For example, Folder.id or Folder.drn is required if you are saving a “Move to Folder” type of rule.

User.context (Required)

Specifies the context identifier for this user's session.

Compose.id

Specifies the identifier of the rule item as returned from Rule.Modify.

Folder.id or Folder.drn

Specifies the folder where items are moved.

Item.bc

Specifies the list of BC recipients.

Item.cc

Specifies the list of CC recipients.

Item.message

Specifies the message text.

Item.subject

Specifies the message subject.

Item.to

Specifies the list of To recipients.

RuleCondition

Specifies the type of condition: Contains, Does Not Contain, Begins With, Matches.

RuleConditionfield

Specifies the GroupWise field used for rule comparison: From, Message, Subject, To.

Rule.Condition.text

Specifies the comparison text for the rule condition.

Rule.drn

Specifies the unique identifier of a rule.

Rule.name (Required)

Specifies the rule name.

Rule.replyTo

Specifies the Reply To mode: 0 (reply to sender) and 1 (reply to all).

Rule.subjectPrefix

Specifies the prefix for the subject field (for example: Fwd:, Re:).

Rule.type (Required)

Specifies the rule type: Delete, Forward, Move to Folder, Reply, and Vacation.

Return Values

Returns the same values as Rule.List.

Example

<FORM method=post action=/servlet/webacc>
   <INPUT type=hidden name=User.context value=xyz>
   <INPUT type=hidden name=action value=Rule.Action>
   <INPUT type=hidden name= Rule.Modify value=1 >
   <INPUT type=hidden name=Compose.id value=2>
   <INPUT type=hidden name=Rule.type value="vacation">
   <INPUT type=text name=Rule.name value="Vacation Rule">
   <INPUT type=text name=Item.subject value="Out of Office">
   <TEXTAREA Name="Item.message" rows=1 cols=1 ></TEXTAREA>
      src="btnsaveus.gif">
</FORM>