2 FS::svc_acct_sm - Object methods for svc_acct_sm records
7 $record = new FS::svc_acct_sm \%hash;
8 $record = new FS::svc_acct_sm { 'column' => 'value' };
10 $error = $record->insert;
12 $error = $new_record->replace($old_record);
14 $error = $record->delete;
16 $error = $record->check;
18 $error = $record->suspend;
20 $error = $record->unsuspend;
22 $error = $record->cancel;
25 An FS::svc_acct object represents a virtual mail alias.
26 FS::svc_acct inherits from FS::Record. The following fields are
29 svcnum - primary key (assigned automatcially for new accounts)
30 domsvc - svcnum of the virtual domain (see the FS::svc_domain manpage)
31 domuid - uid of the target account (see the FS::svc_acct manpage)
32 domuser - virtual username
35 Creates a new virtual mail alias. To add the virtual mail
36 alias to the database, see the section on "insert".
39 Adds this virtual mail alias to the database. If there is an
40 error, returns the error, otherwise returns false.
42 The additional fields pkgnum and svcpart (see the
43 FS::cust_svc manpage) should be defined. An FS::cust_svc
44 record will be created and inserted.
46 If the configuration values (see the FS::Conf manpage)
47 shellmachine and qmailmachines exist, and domuser is `*'
48 (meaning a catch-all mailbox), the command:
50 [ -e $dir/.qmail-$qdomain-default ] || {
51 touch $dir/.qmail-$qdomain-default;
52 chown $uid:$gid $dir/.qmail-$qdomain-default;
55 is executed on shellmachine via ssh (see the section on
56 "EXTENSION ADDRESSES" in the dot-qmail manpage). This
57 behaviour can be surpressed by setting
58 $FS::svc_acct_sm::nossh_hack true.
61 Deletes this virtual mail alias from the database. If there
62 is an error, returns the error, otherwise returns false.
64 The corresponding FS::cust_svc record will be deleted as
68 Replaces OLD_RECORD with this one in the database. If there
69 is an error, returns the error, otherwise returns false.
72 Just returns false (no error) for now.
74 Called by the suspend method of FS::cust_pkg (see the
75 FS::cust_pkg manpage).
78 Just returns false (no error) for now.
80 Called by the unsuspend method of FS::cust_pkg (see the
81 FS::cust_pkg manpage).
84 Just returns false (no error) for now.
86 Called by the cancel method of FS::cust_pkg (see the
87 FS::cust_pkg manpage).
90 Checks all fields to make sure this is a valid virtual mail
91 alias. If there is an error, returns the error, otherwise
92 returns false. Called by the insert and replace methods.
94 Sets any fixed values; see the FS::part_svc manpage.
97 $Id: svc_acct_sm.txt,v 1.3 1999-04-08 13:39:32 ivan Exp $
100 The remote commands should be configurable.
102 The $recref stuff in sub check should be cleaned up.
105 the FS::Record manpage, the FS::Conf manpage, the FS::cust_svc
106 manpage, the FS::part_svc manpage, the FS::cust_pkg manpage, the
107 FS::svc_acct manpage, the FS::svc_domain manpage, the FS::SSH
108 manpage, the ssh manpage, the dot-qmail manpage, schema.html
109 from the base documentation.
112 ivan@voicenet.com 97-jul-16 - 21
114 rewrite ivan@sisd.com 98-mar-10
116 s/qsearchs/qsearch/ to eliminate warning ivan@sisd.com 98-apr-19
118 uses conf/shellmachine and has an nossh_hack ivan@sisd.com 98-
121 s/\./:/g in .qmail-domain:com ivan@sisd.com 98-aug-13
123 pod, FS::Conf, moved .qmail file from check to insert 98-sep-23