Difference between revisions of "Freeside:3:Documentation:Developer/FS/contact email"
From Freeside
m (Edit via perl MediaWiki framework (1.13)) |
m (Edit via perl MediaWiki framework (1.13)) |
||
| Line 18: | Line 18: | ||
</code> | </code> | ||
==DESCRIPTION== | ==DESCRIPTION== | ||
| − | An FS::contact_email object represents | + | 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 | ; contactemailnum | ||
| Line 29: | Line 29: | ||
==METHODS== | ==METHODS== | ||
; new HASHREF | ; new HASHREF | ||
| − | :Creates a new | + | :Creates a new contact email address. To add the email address to the database, see [[#insert|"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. | :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. | ||
| Line 39: | Line 39: | ||
:Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false. | :Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false. | ||
; check | ; check | ||
| − | :Checks all fields to make sure this is a valid | + | :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== | ==BUGS== | ||
| − | |||
| − | |||
==SEE ALSO== | ==SEE ALSO== | ||
| − | [[Freeside:3:Documentation:Developer/FS/Record|FS::Record]] | + | [[Freeside:3:Documentation:Developer/FS/contact|FS::contact]], [[Freeside:3:Documentation:Developer/FS/Record|FS::Record]] |
Revision as of 13:32, 27 June 2014
Contents
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.
