|
|
| Line 1: |
Line 1: |
| − | ==NAME==
| |
| − | FS::acct_snarf - Object methods for acct_snarf records
| |
| | | | |
| − | ==SYNOPSIS==
| |
| − | <code>
| |
| − | use FS::acct_snarf;
| |
| − |
| |
| − | $record = new FS::acct_snarf \%hash;
| |
| − | $record = new FS::acct_snarf { 'column' => 'value' };
| |
| − |
| |
| − | $error = $record->insert;
| |
| − |
| |
| − | $error = $new_record->replace($old_record);
| |
| − |
| |
| − | $error = $record->delete;
| |
| − |
| |
| − | $error = $record->check;
| |
| − | </code>
| |
| − | ==DESCRIPTION==
| |
| − | An FS::svc_acct object represents an external mail account, typically for download of mail. FS::acct_snarf inherits from FS::Record. The following fields are currently supported:
| |
| − |
| |
| − | ; snarfnum - primary key; snarfname - Label; svcnum - Account (see [[Freeside:3:Documentation:Developer/FS/svc acct|FS::svc_acct]]); machine - external machine to download mail from; protocol - protocol (pop3, imap, etc.); username - external login username; _password - external login password
| |
| − | ==METHODS==
| |
| − | ; new HASHREF
| |
| − | :Creates a new record. To add the record 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.
| |
| − | ; 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.
| |
| − | ; cust_svc; svc_export
| |
| − | :Calls the replace export for any communigate exports attached to this rule's service.
| |
| − | ; check
| |
| − | :Checks all fields to make sure this is a valid external mail account. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
| |
| − | ; cgp_hashref
| |
| − | :Returns a hashref representing this external mail account, suitable for Communigate Pro API commands:
| |
| − |
| |
| − | ==BUGS==
| |
| − | ==SEE ALSO==
| |
| − | [[Freeside:3:Documentation:Developer/FS/Record|FS::Record]], schema.html from the base documentation.
| |
