summaryrefslogtreecommitdiff
path: root/htdocs/docs/man/svc_domain.txt
blob: 03d3dbc2714600db7e410907fff1efbc5f545b00 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
NAME
    FS::svc_domain - Object methods for svc_domain records

SYNOPSIS
      use FS::svc_domain;

      $record = create FS::svc_domain \%hash;
      $record = create FS::svc_domain { '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;

DESCRIPTION
    An FS::svc_domain object represents a domain. FS::svc_domain
    inherits from FS::Record. The following fields are currently
    supported:

    svcnum - primary key (assigned automatically for new accounts)
    domain
METHODS
    create HASHREF
        Creates a new domain. To add the domain to the database, see
        the section on "insert".

    insert
        Adds this domain 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.

        The additional field *action* should be set to *N* for new
        domains or *M* for transfers.

        A registration or transfer email will be submitted unless
        $FS::svc_domain::whois_hack is true.

    delete
        Deletes this domain 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 domain. 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.

    _whois
        Executes the command:

          whois do $domain

        and returns the output.

        (Always returns *No match for domian "$domain".* if
        $FS::svc_domain::whois_hack is set true.)

    submit_internic
        Submits a registration email for this domain.

BUGS
    It doesn't properly override FS::Record yet.

    All BIND/DNS fields should be included (and exported).

    All registries should be supported.

    Not all configuration access is through FS::Conf!

    Should change action to a real field.

SEE ALSO
    the FS::Record manpage, the FS::Conf manpage, the FS::cust_svc
    manpage, the FS::part_svc manpage, the FS::cust_pkg manpage, the
    FS::SSH manpage, the ssh manpage, the dot-qmail manpage,
    schema.html from the base documentation, config.html from the
    base documentation.

HISTORY
    ivan@voicenet.com 97-jul-21

    rewrite ivan@sisd.com 98-mar-10

    add internic bits ivan@sisd.com 98-mar-14

    Changed 'day' to 'daytime' because Pg6.3 reserves the day word
    bmccane@maxbaud.net 98-apr-3

    /var/spool/freeside/conf/registries/internic/, Mail::Internet,
    etc. ivan@sisd.com 98-jul-17-19

    pod, some FS::Conf (not complete) ivan@sisd.com 98-sep-23