Difference between revisions of "Freeside:3:Documentation:Developer/FS/svc mailinglist"

Latest revision as of 20:06, 27 June 2012

NAME

FS::svc_mailinglist - Object methods for svc_mailinglist records

SYNOPSIS

 use FS::svc_mailinglist;

 $record = new FS::svc_mailinglist \%hash;
 $record = new FS::svc_mailinglist { 'column' => 'value' };

 $error = $record->insert;

 $error = $new_record->replace($old_record);

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::svc_mailinglist object represents a mailing list customer service. FS::svc_mailinglist inherits from FS::Record. The following fields are currently supported:

svcnum

primary key

username

username

domsvc

domsvc

listnum

listnum

reply_to_group

reply_to_group

remove_author

remove_author

reject_auto

reject_auto

remove_to_and_cc

remove_to_and_cc

METHODS

new HASHREF

Creates a new record. To add the record 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.

insert

Adds this record to the database. If there is an error, returns the error, otherwise returns false.

delete

Delete this record from the database.

replace OLD_RECORD

Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.

check

Checks all fields to make sure this is a valid record. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

mailinglist; listname; label

BUGS

SEE ALSO

FS::Record, schema.html from the base documentation.