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

Latest revision as of 07:18, 18 November 2015

NAME

FS::contact_email - Object methods for contact_email records

SYNOPSIS

 use FS::contact_email;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::contact_email object represents a contact's email address. FS::contact_email inherits from FS::Record. The following fields are currently supported:

contactemailnum

primary key

contactnum

contactnum

emailaddress

emailaddress

METHODS

new HASHREF

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

BUGS

SEE ALSO

FS::contact, FS::Record