Skip to content

Commit 5b95bd9

Browse files
author
Demian
committed
Fixed and added documentation for mail_relay_domain_* functions
1 parent 679f9eb commit 5b95bd9

File tree

5 files changed

+137
-1
lines changed

5 files changed

+137
-1
lines changed

remoting_client/API-docs/mail_relay_domain_add.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ <h1>mail_relay_domain_add(<span class="var">$session_id</span>, <span class="var
2020
<p class="margin"> <span class="var">$session_id</span>, <span class="var">$client_id</span>, <span class="var">$params</span></p>
2121
<p class="headgrp">Parameters (in <span class="var">$params</span>): </p>
2222
<p class="margin"> server_id&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
23-
<p class="margin"> source&nbsp;&nbsp;Recipient address (<span class="paratype">varchar(255)</span>)</p>
23+
<p class="margin"> source&nbsp;&nbsp;(<span class="paratype">varchar(255)</span>)</p>
2424
<p class="margin"> active&nbsp;&nbsp;(<span class="paratype">enum('n','y')</span>)</p>
2525
<p class="margin"> access&nbsp;&nbsp;(<span class="paratype">varchar(255)</span>)</p>
2626
<p class="headgrp">Output: </p>
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>ISPCOnfig 3 remote API documentation</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>mail_relay_domain_get(<span class="var">$session_id</span>, <span class="var">$primary_id</span>);</h1>
16+
<br>
17+
<p class="headgrp">Description: </p>
18+
<p class="margin"> Retrieves information about a relay domain.</p><br>
19+
<p class="headgrp">Input Variables: </p>
20+
<p class="margin"> <span class="var">$session_id</span>, <span class="var">$primary_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 relay domain.</p>
25+
<!--<b>Output:</b>
26+
<p style="margin-left:100px">Gives a record of </p> -->
27+
</div>
28+
29+
</body></html>
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<html><head><title>ISPCOnfig 3 remote API documentation</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>mail_relay_domain_update(<span class="var">$session_id</span>, <span class="var">$client_id</span>, <span class="var">$primary_id</span>, <span class="var">$params</span>);</h1>
16+
<br>
17+
<b>Description: </b>
18+
<p class="margin"> Updates a relay domain.</p><br>
19+
<b>Input Variables: </b>
20+
<p class="margin"> <span class="var">$session_id</span>, <span class="var">$client_id</span>, <span class="var">$primary_id</span>, <span class="var">$params</span></p>
21+
<b>Parameters (in <span class="var">$params</span>): </b>
22+
<p class="margin"> server_id&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
23+
<p class="margin"> source&nbsp;&nbsp;(<span class="paratype">varchar(255)</span>)</p>
24+
<p class="margin"> active&nbsp;&nbsp;(<span class="paratype">enum('n','y')</span>)</p>
25+
<p class="margin"> access&nbsp;&nbsp;(<span class="paratype">varchar(255)</span>)</p>
26+
<b>Output: </b>
27+
<p class="margin"> Returns the number of affected rows.</p>
28+
<!--<b>Output:</b>
29+
<p style="margin-left:100px">Gives a record of </p> -->
30+
</div>
31+
32+
</body></html>
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<?php
2+
3+
require 'soap_config.php';
4+
5+
6+
$client = new SoapClient(null, array('location' => $soap_location,
7+
'uri' => $soap_uri,
8+
'trace' => 1,
9+
'exceptions' => 1));
10+
11+
12+
try {
13+
if($session_id = $client->login($username, $password)) {
14+
echo 'Logged successfull. Session ID:'.$session_id.'<br />';
15+
}
16+
17+
//* Set the function parameters.
18+
$relay_domain_id = 1;
19+
20+
// Lookup by primary key, gets back a single record.
21+
$relay_domain = $client->mail_relay_domain_get($session_id, $relay_domain_id);
22+
print_r($relay_domain);
23+
24+
if($client->logout($session_id)) {
25+
echo 'Logged out.<br />';
26+
}
27+
28+
29+
} catch (SoapFault $e) {
30+
echo $client->__getLastResponse();
31+
die('SOAP Error: '.$e->getMessage());
32+
}
33+
34+
?>
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<?php
2+
3+
require 'soap_config.php';
4+
5+
6+
$client = new SoapClient(null, array('location' => $soap_location,
7+
'uri' => $soap_uri,
8+
'trace' => 1,
9+
'exceptions' => 1));
10+
11+
12+
try {
13+
if($session_id = $client->login($username, $password)) {
14+
echo 'Logged successfull. Session ID:'.$session_id.'<br />';
15+
}
16+
17+
//* Set the function parameters.
18+
$client_id = 1;
19+
$primary_id = 1;
20+
$params = array(
21+
'server_id' => 1,
22+
'domain' => 'test.tld',
23+
'active' => 'y',
24+
'access' => 'OK'
25+
);
26+
27+
$affected_rows = $client->mail_relay_domain_update($session_id, $client_id, $primary_id, $params);
28+
29+
echo "Affected Rows: ".$affected_rows."<br>";
30+
31+
if($client->logout($session_id)) {
32+
echo 'Logged out.<br />';
33+
}
34+
35+
36+
} catch (SoapFault $e) {
37+
echo $client->__getLastResponse();
38+
die('SOAP Error: '.$e->getMessage());
39+
}
40+
41+
?>

0 commit comments

Comments
 (0)