Skip to content

Commit 413d3b2

Browse files
tbrehmtbrehm
committed
Added remote API documentation and remote api example functions.
1 parent d6cd459 commit 413d3b2

File tree

416 files changed

+14051
-1859
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

416 files changed

+14051
-1859
lines changed

‎docs/Remote_API_docs.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
3+
The remote API documentation is in the remote_client/API-docs subfolder.

‎remoting_client/API-docs/client_add.html‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<html><head><title>Postfix Monitoring With Mailgraph And pflogsumm</title>
3+
4+
5+
6+
7+
8+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
9+
<link rel="stylesheet" type="text/css" href="definitionen.css">
10+
<style type="text/css">
11+
</style></head>
12+
13+
<body>
14+
<div style="padding:40px">
15+
<h1>client_add(<span class="var">$session_id</span>, <span class="var">$reseller_id</span>, <span class="var">$params</span>);</h1>
16+
<br>
17+
<p class="headgrp">Description: </p>
18+
<p class="margin"> Adds a new client.</p><br>
19+
<p class="headgrp">Input Variables: </p>
20+
<p class="margin"> <span class="var">$session_id</span>, <span class="var">$reseller_id</span>, <span class="var">$params</span></p>
21+
<p class="headgrp">Parameters (in <span class="var">$params</span>): </p>
22+
<p class="margin"> company_name&nbsp;&nbsp;(<span class="paratype">varchar(64)</span>)</p>
23+
<p class="margin"> contact_name&nbsp;&nbsp;(<span class="paratype">varchar(64)</span>)</p>
24+
<p class="margin"> customer_no&nbsp;&nbsp;(<span class="paratype">varchar(64)</span>)</p>
25+
<p class="margin"> vat_id&nbsp;&nbsp;(<span class="paratype">varchar(64)</span>)</p>
26+
<p class="margin"> street&nbsp;&nbsp;(<span class="paratype">varchar(255)</span>)</p>
27+
<p class="margin"> zip&nbsp;&nbsp;(<span class="paratype">varchar(32)</span>)</p>
28+
<p class="margin"> city&nbsp;&nbsp;(<span class="paratype">varchar(64)</span>)</p>
29+
<p class="margin"> state&nbsp;&nbsp;(<span class="paratype">varchar(32)</span>)</p>
30+
<p class="margin"> country&nbsp;&nbsp;(<span class="paratype">char(2)</span>)</p>
31+
<p class="margin"> telephone&nbsp;&nbsp;(<span class="paratype">varchar(32)</span>)</p>
32+
<p class="margin"> mobile&nbsp;&nbsp;(<span class="paratype">varchar(32)</span>)</p>
33+
<p class="margin"> fax&nbsp;&nbsp;(<span class="paratype">varchar(32)</span>)</p>
34+
<p class="margin"> email&nbsp;&nbsp;(<span class="paratype">varchar(255)</span>)</p>
35+
<p class="margin"> internet&nbsp;&nbsp;(<span class="paratype">varchar(255)</span>)</p>
36+
<p class="margin"> icq&nbsp;&nbsp;(<span class="paratype">varchar(16)</span>)</p>
37+
<p class="margin"> notes&nbsp;&nbsp;(<span class="paratype">text</span>)</p>
38+
<p class="margin"> default_mailserver&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
39+
<p class="margin"> limit_maildomain&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
40+
<p class="margin"> limit_mailbox&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
41+
<p class="margin"> limit_mailalias&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
42+
<p class="margin"> limit_mailaliasdomain&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
43+
<p class="margin"> limit_mailforward&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
44+
<p class="margin"> limit_mailcatchall&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
45+
<p class="margin"> limit_mailrouting&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
46+
<p class="margin"> limit_mailfilter&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
47+
<p class="margin"> limit_fetchmail&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
48+
<p class="margin"> limit_mailquota&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
49+
<p class="margin"> limit_spamfilter_wblist&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
50+
<p class="margin"> limit_spamfilter_user&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
51+
<p class="margin"> limit_spamfilter_policy&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
52+
<p class="margin"> default_webserver&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
53+
<p class="margin"> limit_web_ip&nbsp;&nbsp;(<span class="paratype">text</span>)</p>
54+
<p class="margin"> limit_web_domain&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
55+
<p class="margin"> limit_web_quota&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
56+
<p class="margin"> web_php_options&nbsp;&nbsp;(<span class="paratype">varchar(255)</span>)</p>
57+
<p class="margin"> limit_web_subdomain&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
58+
<p class="margin"> limit_web_aliasdomain&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
59+
<p class="margin"> limit_ftp_user&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
60+
<p class="margin"> limit_shell_user&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
61+
<p class="margin"> ssh_chroot&nbsp;&nbsp;(<span class="paratype">varchar(255)</span>)</p>
62+
<p class="margin"> limit_webdav_user&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
63+
<p class="margin"> default_dnsserver&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
64+
<p class="margin"> limit_dns_zone&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
65+
<p class="margin"> limit_dns_slave_zone&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
66+
<p class="margin"> limit_dns_record&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
67+
<p class="margin"> default_dbserver&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
68+
<p class="margin"> limit_database&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
69+
<p class="margin"> limit_cron&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
70+
<p class="margin"> limit_cron_type&nbsp;&nbsp;(<span class="paratype">enum('url','chrooted','full')</span>)</p>
71+
<p class="margin"> limit_cron_frequency&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
72+
<p class="margin"> limit_traffic_quota&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
73+
<p class="margin"> limit_client&nbsp;&nbsp;(<span class="paratype">varchar(64)</span>)</p>
74+
<p class="margin"> parent_client_id&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
75+
<p class="margin"> username&nbsp;&nbsp;(<span class="paratype">varchar(64)</span>)</p>
76+
<p class="margin"> password&nbsp;&nbsp;(<span class="paratype">varchar(64)</span>)</p>
77+
<p class="margin"> language&nbsp;&nbsp;(<span class="paratype">char(2)</span>)</p>
78+
<p class="margin"> usertheme&nbsp;&nbsp;(<span class="paratype">varchar(32)</span>)</p>
79+
<p class="margin"> template_master&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
80+
<p class="margin"> template_additional&nbsp;&nbsp;(<span class="paratype">varchar(255)</span>)</p>
81+
<p class="margin"> created_at&nbsp;&nbsp;(<span class="paratype">bigint(20)</span>)</p>
82+
<p class="headgrp">Output: </p>
83+
<p class="margin"> Returns the ID of the newly added Client.</p>
84+
<!--<b>Output:</b>
85+
<p style="margin-left:100px">Gives a record of </p> -->
86+
</div>
87+
88+
</body></html>

‎remoting_client/API-docs/client_change_password.html‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<html><head><title>Postfix Monitoring With Mailgraph And pflogsumm</title>
3+
4+
5+
6+
7+
8+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
9+
<link rel="stylesheet" type="text/css" href="definitionen.css">
10+
<style type="text/css">
11+
</style></head>
12+
13+
<body>
14+
<div style="padding:40px">
15+
<h1>client_change_password(<span class="var">$session_id</span>, <span class="var">$client_id</span>, <span class="var">$new_password</span>);</h1>
16+
<br>
17+
<p class="headgrp">Description: </p>
18+
<p class="margin"> Changes a client's password.</p><br>
19+
<p class="headgrp">Input Variables: </p>
20+
<p class="margin"> <span class="var">$session_id</span>, <span class="var">$client_id</span>, <span class="var">$new_password</span></p>
21+
<p class="headgrp">Parameters (in <span class="var">$params</span>): </p>
22+
<p class="margin"> None</p>
23+
<p class="headgrp">Output: </p>
24+
<p class="margin"> Returns '1' if password has been changed.</p>
25+
<p class="headgrp">SQL Interaction:</p>
26+
<p class="margin"> "SELECT client_id FROM client WHERE client_id = ".<span class="var">$client_id</span></p>
27+
<!--<b>Output:</b>
28+
<p style="margin-left:100px">Gives a record of </p> -->
29+
</div>
30+
31+
</body></html>

‎remoting_client/API-docs/client_delete.html‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<html><head><title>Postfix Monitoring With Mailgraph And pflogsumm</title>
3+
4+
5+
6+
7+
8+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
9+
<link rel="stylesheet" type="text/css" href="definitionen.css">
10+
<style type="text/css">
11+
</style></head>
12+
13+
<body>
14+
<div style="padding:40px">
15+
<h1>client_delete(<span class="var">$session_id</span>, <span class="var">$client_id</span>);</h1>
16+
<br>
17+
<p class="headgrp">Description: </p>
18+
<p class="margin"> Deletes a client.</p><br>
19+
<p class="headgrp">Input Variables: </p>
20+
<p class="margin"> <span class="var">$session_id</span>, <span class="var">$client_id</span></p>
21+
<p class="headgrp">Parameters (in <span class="var">$params</span>): </p>
22+
<p class="margin">None</p>
23+
<p class="headgrp">Output: </p>
24+
<p class="margin"> Returns the number of deleted records.</p>
25+
<!--<b>Output:</b>
26+
<p style="margin-left:100px">Gives a record of </p> -->
27+
</div>
28+
29+
</body></html>

‎remoting_client/API-docs/client_delete_everything.html‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<html><head><title>Postfix Monitoring With Mailgraph And pflogsumm</title>
3+
4+
5+
6+
7+
8+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
9+
<link rel="stylesheet" type="text/css" href="definitionen.css">
10+
<style type="text/css">
11+
</style></head>
12+
13+
<body>
14+
<div style="padding:40px">
15+
<h1>client_delete_everything(<span class="var">$session_id</span>, <span class="var">$client_id</span>);</h1>
16+
<br>
17+
<p class="headgrp">Description: </p>
18+
<p class="margin"> Deletes client.</p><br>
19+
<p class="headgrp">Input Variables: </p>
20+
<p class="margin"> <span class="var">$session_id</span>, <span class="var">$client_id</span></p>
21+
<p class="headgrp">Parameters (in <span class="var">$params</span>): </p>
22+
<p class="margin"> None</p>
23+
<p class="headgrp">Output: </p>
24+
<p class="margin"> </p>
25+
<p class="headgrp">SQL Interaction:</p>
26+
<p class="margin"> "SELECT groupid FROM sys_group WHERE client_id = <span class="var">$client_id</span>"</p>
27+
<!--<b>Output:</b>
28+
<p style="margin-left:100px">Gives a record of </p> -->
29+
</div>
30+
31+
</body></html>

‎remoting_client/API-docs/client_get.html‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<html><head><title>Postfix Monitoring With Mailgraph And pflogsumm</title>
3+
4+
5+
6+
7+
8+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
9+
<link rel="stylesheet" type="text/css" href="definitionen.css">
10+
<style type="text/css">
11+
</style></head>
12+
13+
<body>
14+
<div style="padding:40px">
15+
<h1>client_get(<span class="var">$session_id</span>, <span class="var">$client_id</span>);</h1>
16+
<br>
17+
<p class="headgrp">Description: </p>
18+
<p class="margin"> Retrieves information about a client.</p><br>
19+
<p class="headgrp">Input Variables: </p>
20+
<p class="margin"> <span class="var">$session_id</span>, <span class="var">$client_id</span></p>
21+
<p class="headgrp">Parameters (in <span class="var">$params</span>): </p>
22+
<p class="margin"> None</p>
23+
<p class="headgrp">Output: </p>
24+
<p class="margin"> Returns all fields and values of the chosen client.</p>
25+
<!--<b>Output:</b>
26+
<p style="margin-left:100px">Gives a record of </p> -->
27+
</div>
28+
29+
</body></html>

‎remoting_client/API-docs/client_get_by_username.html‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<html><head><title>Postfix Monitoring With Mailgraph And pflogsumm</title>
3+
4+
5+
6+
7+
8+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
9+
<link rel="stylesheet" type="text/css" href="definitionen.css">
10+
<style type="text/css">
11+
</style></head>
12+
13+
<body>
14+
<div style="padding:40px">
15+
<h1>client_get_by_username(<span class="var">$session_id</span>, <span class="var">$username</span>);</h1>
16+
<br>
17+
<p class="headgrp">Description: </p>
18+
<p class="margin"> Shows client information of user.</p><br>
19+
<p class="headgrp">Input Variables: </p>
20+
<p class="margin"> <span class="var">$session_id</span>, <span class="var">$username</span></p>
21+
<p class="headgrp">Parameters (in <span class="var">$params</span>): </p>
22+
<p class="margin"> None</p>
23+
<p class="headgrp">Output: </p>
24+
<p class="margin"> Returns client information of the user specified by his or her name.</p>
25+
<p class="headgrp">SQL Interaction:</p>
26+
<p class="margin"> "SELECT * FROM sys_user WHERE username = '".<span class="var">$username</span>."'"</p>
27+
<!--<b>Output:</b>
28+
<p style="margin-left:100px">Gives a record of </p> -->
29+
</div>
30+
31+
</body></html>

‎remoting_client/API-docs/client_get_id.html‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<html><head><title>Postfix Monitoring With Mailgraph And pflogsumm</title>
3+
4+
5+
6+
7+
8+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
9+
<link rel="stylesheet" type="text/css" href="definitionen.css">
10+
<style type="text/css">
11+
</style></head>
12+
13+
<body>
14+
<div style="padding:40px">
15+
<h1>client_get_id(<span class="var">$session_id</span>, <span class="var">$sys_userid</span>);</h1>
16+
<br>
17+
<p class="headgrp">Description: </p>
18+
<p class="margin"> Retrieves the client ID of the system user.</p><br>
19+
<p class="headgrp">Input Variables: </p>
20+
<p class="margin"> <span class="var">$session_id</span>, <span class="var">$sys_userid</span></p>
21+
<p class="headgrp">Parameters (in <span class="var">$params</span>): </p>
22+
<p class="margin"> None</p>
23+
<p class="headgrp">Output: </p>
24+
<p class="margin"> Returns the client ID of the user with the entered system user ID.</p>
25+
<!--<b>Output:</b>
26+
<p style="margin-left:100px">Gives a record of </p> -->
27+
</div>
28+
29+
</body></html>

‎remoting_client/API-docs/client_get_sites_by_user.html‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<html><head><title>Postfix Monitoring With Mailgraph And pflogsumm</title>
3+
4+
5+
6+
7+
8+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
9+
<link rel="stylesheet" type="text/css" href="definitionen.css">
10+
<style type="text/css">
11+
</style></head>
12+
13+
<body>
14+
<div style="padding:40px">
15+
<h1>client_get_sites_by_user(<span class="var">$session_id</span>, <span class="var">$sys_userid</span>, <span class="var">$sys_groupid</span>);</h1>
16+
<br>
17+
<p class="headgrp">Description: </p>
18+
<p class="margin"> Shows sites of a single user.</p><br>
19+
<p class="headgrp">Input Variables: </p>
20+
<p class="margin"> <span class="var">$session_id</span>, <span class="var">$sys_userid</span>, <span class="var">$sys_groupid</span></p>
21+
<p class="headgrp">Parameters (in <span class="var">$params</span>): </p>
22+
<p class="margin"> None</p>
23+
<p class="headgrp">Output: </p>
24+
<p class="margin"> Shows sites and its values belonging to the specified user.</p>
25+
<p class="headgrp">SQL Interaction:</p>
26+
<p class="margin"> "SELECT domain, domain_id, document_root, active FROM web_domain WHERE ( (sys_userid = <span class="var">$sys_userid</span> AND sys_perm_user LIKE '%r%') OR (sys_groupid IN (<span class="var">$group_list</span>) AND sys_perm_group LIKE '%r%') OR sys_perm_other LIKE '%r%') AND type = 'vhost'"</p>
27+
<!--<b>Output:</b>
28+
<p style="margin-left:100px">Gives a record of </p> -->
29+
</div>
30+
31+
</body></html>

‎remoting_client/API-docs/client_templates_get_all.html‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<html><head><title>Postfix Monitoring With Mailgraph And pflogsumm</title>
3+
4+
5+
6+
7+
8+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
9+
<link rel="stylesheet" type="text/css" href="definitionen.css">
10+
<style type="text/css">
11+
</style></head>
12+
13+
<body>
14+
<div style="padding:40px">
15+
<h1>client_templates_get_all(<span class="var">$session_id</span>);</h1>
16+
<br>
17+
<p class="headgrp">Description: </p>
18+
<p class="margin"> Returns all client templates.</p><br>
19+
<p class="headgrp">Input Variables: </p>
20+
<p class="margin"> <span class="var">$session_id</span></p>
21+
<p class="headgrp">Parameters (in <span class="var">$params</span>): </p>
22+
<p class="margin"> None.</p>
23+
<p class="headgrp">Output: </p>
24+
<p class="margin"> Returns an array with the parameter values of all client templates.</p>
25+
<p class="headgrp">SQL Interaction:</p>
26+
<p class="margin"> "SELECT * FROM client_template"</p>
27+
<!--<b>Output:</b>
28+
<p style="margin-left:100px">Gives a record of </p> -->
29+
</div>
30+
31+
</body></html>

0 commit comments

Comments
 (0)