% 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::svc_forward - Object methods for svc_forward records
use FS::svc_forward;
$record = new FS::svc_forward \%hash;
$record = new FS::svc_forward { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
$error = $record->suspend;
$error = $record->unsuspend;
$error = $record->cancel;
An FS::svc_forward object represents a mail forwarding alias. FS::svc_forward inherits from FS::Record. The following fields are currently supported:
Creates a new mail forwarding alias. To add the mail forwarding alias to the database, see "insert".
Class method which returns an SQL fragment to search for the given string.
Returns a text string representing this forward.
END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with history records.
Adds this mail forwarding alias to the database. If there is an error, returns the error, otherwise returns false.
The additional fields pkgnum and svcpart (see FS::cust_svc) should be defined. An FS::cust_svc record will be created and inserted.
Currently available options are: depend_jobnum
If depend_jobnum is set (to a scalar jobnum or an array reference of jobnums), all provisioning jobs will have a dependancy on the supplied jobnum(s) (they will not run until the specific job(s) complete(s)).
Deletes this mail forwarding alias from the database. If there is an error, returns the error, otherwise returns false.
The corresponding FS::cust_svc record will be deleted as well.
Replaces OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
Just returns false (no error) for now.
Called by the suspend method of FS::cust_pkg (see FS::cust_pkg).
Just returns false (no error) for now.
Called by the unsuspend method of FS::cust_pkg (see FS::cust_pkg).
Just returns false (no error) for now.
Called by the cancel method of FS::cust_pkg (see FS::cust_pkg).
Checks all fields to make sure this is a valid mail forwarding alias. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
Sets any fixed values; see FS::part_svc.
Returns the FS::svc_acct object referenced by the srcsvc column, or false for literally specified forwards.
Returns the FS::svc_acct object referenced by the srcsvc column, or false for literally specified forwards.
Returns the email address to be forwarded regardless of weither it is local or remote
Returns the email address which gets forwarded to regardless of weither it is local or remote
Returns the domain of the srcsvc_acct
FS::Record, FS::Conf, FS::cust_svc, FS::part_svc, FS::cust_pkg, FS::svc_acct, FS::svc_domain, schema.html from the base documentation.