struct Rule in module com::sun::star::ucb::

(Global Index)

Syntax

struct Rule;

Description

describes a rule that can be applies to a number of objects.

A rule consists of a sequence of RuleTerm>/type>s describing the objects to which the rule should be applied, the RuleAction which should be used on the matching objects, and a parameter.

Field Summary

Terms the rule terms describing the objects to which the rule should be applied.

Parameter Some RuleAction s require a parameter.

Action the action to perform on the matching objects.

Field Details



Terms

Syntax

sequence< com::sun::star::ucb::RuleTerm > Terms;

Description

the rule terms describing the objects to which the rule should be applied.


Parameter

Syntax

string Parameter;

Description

Some RuleAction s require a parameter.

Action Parameter
COPY, MOVE, LINK The URL to the destination folder.
FORWARD The email address of the recepient
All other actions n/a

Action

Syntax

short Action;

Description

the action to perform on the matching objects.

The value can be one of the RuleAction constants.

Top of Page