From ea0d3938b57a079ce4aa6db0cae316e3ac6da654 Mon Sep 17 00:00:00 2001 From: ivan Date: Tue, 29 Jan 2002 17:46:41 +0000 Subject: these are all auto-generated by the installation; don't check them into CVS (probably should generate them for a release tarball though) --- httemplate/docs/man/FS/svc_acct_sm.html | 150 -------------------------------- 1 file changed, 150 deletions(-) delete mode 100644 httemplate/docs/man/FS/svc_acct_sm.html (limited to 'httemplate/docs/man/FS/svc_acct_sm.html') diff --git a/httemplate/docs/man/FS/svc_acct_sm.html b/httemplate/docs/man/FS/svc_acct_sm.html deleted file mode 100644 index 86c7b8b3b..000000000 --- a/httemplate/docs/man/FS/svc_acct_sm.html +++ /dev/null @@ -1,150 +0,0 @@ - - -FS::svc_acct_sm - Object methods for svc_acct_sm records - - - - - - - - -

- - -

NAME

FS::svc_acct_sm - Object methods for svc_acct_sm records

SYNOPSIS

-  use FS::svc_acct_sm;

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

-  $error = $record->insert;

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

-  $error = $record->delete;

-  $error = $record->check;

-  $error = $record->suspend;

-  $error = $record->unsuspend;

-  $error = $record->cancel;

WARNING

FS::svc_acct_sm is depreciated. This class is only included for migration -purposes. See the FS::svc_forward manpage.

DESCRIPTION

An FS::svc_acct_sm object represents a virtual mail alias. FS::svc_acct_sm -inherits from FS::Record. The following fields are currently supported:

svcnum - primary key (assigned automatcially for new accounts)
-: -
domsvc - svcnum of the virtual domain (see the FS::svc_domain manpage)
-: -
domuid - uid of the target account (see the FS::svc_acct manpage)
-: -
domuser - virtual username
-: -

METHODS

new HASHREF
-

-Creates a new virtual mail alias. To add the virtual mail alias to the -database, see insert. -

insert
-

-Adds this virtual mail alias to the database. If there is an error, returns -the error, otherwise returns false. -

The additional fields pkgnum and svcpart (see the FS::cust_svc manpage) should be -defined. An FS::cust_svc record will be created and inserted.

- #If the configuration values (see L<FS::Conf>) shellmachine and qmailmachines
- #exist, and domuser is `*' (meaning a catch-all mailbox), the command:
- #
- #  [ -e $dir/.qmail-$qdomain-default ] || {
- #    touch $dir/.qmail-$qdomain-default;
- #    chown $uid:$gid $dir/.qmail-$qdomain-default;
- #  }
- #
- #is executed on shellmachine via ssh (see L<dot-qmail/"EXTENSION ADDRESSES">).
- #This behaviour can be surpressed by setting $FS::svc_acct_sm::nossh_hack true.

delete
-

-Deletes this virtual mail alias from the database. If there is an error, -returns the error, otherwise returns false. -

The corresponding FS::cust_svc record will be deleted as well.

replace OLD_RECORD
-

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

suspend
-

-Just returns false (no error) for now. -

Called by the suspend method of FS::cust_pkg (see the FS::cust_pkg manpage).

unsuspend
-

-Just returns false (no error) for now. -

Called by the unsuspend method of FS::cust_pkg (see the FS::cust_pkg manpage).

cancel
-

-Just returns false (no error) for now. -

Called by the cancel method of FS::cust_pkg (see the FS::cust_pkg manpage).

check
-

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

Sets any fixed values; see the FS::part_svc manpage.

VERSION

$Id: svc_acct_sm.html,v 1.3 2002-01-29 17:42:46 ivan Exp $

BUGS

The remote commands should be configurable.

The $recref stuff in sub check should be cleaned up.