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

Latest revision as of 07:24, 18 November 2015

NAME

FS::mailinglist - Object methods for mailinglist records

SYNOPSIS

 use FS::mailinglist;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

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

listnum

primary key

listname

Mailing list name

METHODS

new HASHREF

Creates a new mailing list. To add the mailing list 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 mailing list. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

mailinglistmember; svc_mailinglist

BUGS

SEE ALSO

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