% include( '/elements/header.html', 'Developer Documentation' ) %> <& /elements/menubar.html, 'Freeside Perl Modules' => $fsurl.'docs/library/FS.html', 'Complete Index' => $fsurl.'docs/library/index.html', &>
FS::cgp_rule_action - Object methods for cgp_rule_action records
use FS::cgp_rule_action;
$record = new FS::cgp_rule_action \%hash;
$record = new FS::cgp_rule_action { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
An FS::cgp_rule_action object represents a mail filtering action. FS::cgp_rule_action inherits from FS::Record. The following fields are currently supported:
primary key
action
params
rulenum
Creates a new action. To add the action to the database, see "insert".
Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the hash method.
Adds this record to the database. If there is an error, returns the error, otherwise returns false.
Delete this record from the database.
Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
Checks all fields to make sure this is a valid action. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
FS::Record, schema.html from the base documentation.