From 211b496acbba8bf3e7d2113c9dc5ce23eb9de5e1 Mon Sep 17 00:00:00 2001
From: Herman van Rink <rink@initfour.nl>
Date: Tue, 28 Apr 2020 09:10:30 +0200
Subject: [PATCH] Add API docs for mail_relay_recipient functions, #3200
---
.../API-docs/mail_relay_recipient_add.html | 31 +++++++++++++++++++
.../API-docs/mail_relay_recipient_delete.html | 29 +++++++++++++++++
.../API-docs/mail_relay_recipient_get.html | 29 +++++++++++++++++
.../API-docs/mail_relay_recipient_update.html | 31 +++++++++++++++++++
remoting_client/API-docs/navigation.html | 4 +++
5 files changed, 124 insertions(+)
create mode 100644 remoting_client/API-docs/mail_relay_recipient_add.html
create mode 100644 remoting_client/API-docs/mail_relay_recipient_delete.html
create mode 100644 remoting_client/API-docs/mail_relay_recipient_get.html
create mode 100644 remoting_client/API-docs/mail_relay_recipient_update.html
diff --git a/remoting_client/API-docs/mail_relay_recipient_add.html b/remoting_client/API-docs/mail_relay_recipient_add.html
new file mode 100644
index 0000000000..5e4c2cdfd5
--- /dev/null
+++ b/remoting_client/API-docs/mail_relay_recipient_add.html
@@ -0,0 +1,31 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html><head><title>ISPCOnfig 3 remote API documentation</title>
+
+
+
+
+
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <link rel="stylesheet" type="text/css" href="definitionen.css">
+ <style type="text/css">
+ </style></head>
+
+<body>
+<div style="padding:40px">
+<h1>mail_relay_recipient_add(<span class="var">$session_id</span>, <span class="var">$client_id</span>, <span class="var">$params</span>);</h1>
+<br>
+<p class="headgrp">Description: </p>
+<p class="margin"> Adds a new relay recipient.</p><br>
+<p class="headgrp">Input Variables: </p>
+<p class="margin"> <span class="var">$session_id</span>, <span class="var">$client_id</span>, <span class="var">$params</span></p>
+<p class="headgrp">Parameters (in <span class="var">$params</span>): </p>
+<p class="margin"> server_id (<span class="paratype">int(11)</span>)</p>
+<p class="margin"> source Recipient address (<span class="paratype">varchar(255)</span>)</p>
+<p class="margin"> active (<span class="paratype">enum('n','y')</span>)</p>
+<p class="headgrp">Output: </p>
+<p class="margin"> Returns the ID of the newly added recordd</p>
+<!--<b>Output:</b>
+<p style="margin-left:100px">Gives a record of </p> -->
+</div>
+
+</body></html>
diff --git a/remoting_client/API-docs/mail_relay_recipient_delete.html b/remoting_client/API-docs/mail_relay_recipient_delete.html
new file mode 100644
index 0000000000..ea765a9e12
--- /dev/null
+++ b/remoting_client/API-docs/mail_relay_recipient_delete.html
@@ -0,0 +1,29 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html><head><title>ISPCOnfig 3 remote API documentation</title>
+
+
+
+
+
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <link rel="stylesheet" type="text/css" href="definitionen.css">
+ <style type="text/css">
+ </style></head>
+
+<body>
+<div style="padding:40px">
+<h1>mail_relay_recipient_delete(<span class="var">$session_id</span>, <span class="var">$primary_id</span>);</h1>
+<br>
+<p class="headgrp">Description: </p>
+<p class="margin"> Deletes a relay recipient.</p><br>
+<p class="headgrp">Input Variables: </p>
+<p class="margin"> <span class="var">$session_id</span>, <span class="var">$primary_id</span></p>
+<p class="headgrp">Parameters (in <span class="var">$params</span>): </p>
+<p class="margin">None</p>
+<p class="headgrp">Output: </p>
+<p class="margin"> Returns the number of deleted records.</p>
+<!--<b>Output:</b>
+<p style="margin-left:100px">Gives a record of </p> -->
+</div>
+
+</body></html>
diff --git a/remoting_client/API-docs/mail_relay_recipient_get.html b/remoting_client/API-docs/mail_relay_recipient_get.html
new file mode 100644
index 0000000000..a1540e24d9
--- /dev/null
+++ b/remoting_client/API-docs/mail_relay_recipient_get.html
@@ -0,0 +1,29 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html><head><title>ISPCOnfig 3 remote API documentation</title>
+
+
+
+
+
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <link rel="stylesheet" type="text/css" href="definitionen.css">
+ <style type="text/css">
+ </style></head>
+
+<body>
+<div style="padding:40px">
+<h1>mail_relay_recipient_get(<span class="var">$session_id</span>, <span class="var">$primary_id</span>);</h1>
+<br>
+<p class="headgrp">Description: </p>
+<p class="margin"> Retrieves information about a relay recipient.</p><br>
+<p class="headgrp">Input Variables: </p>
+<p class="margin"> <span class="var">$session_id</span>, <span class="var">$primary_id</span></p>
+<p class="headgrp">Parameters (in <span class="var">$params</span>): </p>
+<p class="margin"> None</p>
+<p class="headgrp">Output: </p>
+<p class="margin"> Returns all fields and values of the chosen relay recipient.</p>
+<!--<b>Output:</b>
+<p style="margin-left:100px">Gives a record of </p> -->
+</div>
+
+</body></html>
diff --git a/remoting_client/API-docs/mail_relay_recipient_update.html b/remoting_client/API-docs/mail_relay_recipient_update.html
new file mode 100644
index 0000000000..417ef40eeb
--- /dev/null
+++ b/remoting_client/API-docs/mail_relay_recipient_update.html
@@ -0,0 +1,31 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html><head><title>ISPCOnfig 3 remote API documentation</title>
+
+
+
+
+
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <link rel="stylesheet" type="text/css" href="definitionen.css">
+ <style type="text/css">
+ </style></head>
+
+<body>
+<div style="padding:40px">
+<h1>mail_relay_recipient_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>
+<br>
+<b>Description: </b>
+<p class="margin"> Updates a relay recipient.</p><br>
+<b>Input Variables: </b>
+<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>
+<b>Parameters (in <span class="var">$params</span>): </b>
+<p class="margin"> server_id (<span class="paratype">int(11)</span>)</p>
+<p class="margin"> source Recipient address (<span class="paratype">varchar(255)</span>)</p>
+<p class="margin"> active (<span class="paratype">enum('n','y')</span>)</p>
+<b>Output: </b>
+<p class="margin"> Returns the number of affected rows.</p>
+<!--<b>Output:</b>
+<p style="margin-left:100px">Gives a record of </p> -->
+</div>
+
+</body></html>
diff --git a/remoting_client/API-docs/navigation.html b/remoting_client/API-docs/navigation.html
index d8c296801b..02b5876b3d 100644
--- a/remoting_client/API-docs/navigation.html
+++ b/remoting_client/API-docs/navigation.html
@@ -161,6 +161,10 @@
<p><a href="mail_transport_delete.html" target="content">mail_transport_delete</a></p>
<p><a href="mail_transport_get.html" target="content">mail_transport_get</a></p>
<p><a href="mail_transport_update.html" target="content">mail_transport_update</a></p>
+<p><a href="mail_relay_recipient_add.html" target="content">mail_relay_recipient_add</a></p>
+<p><a href="mail_relay_recipient_delete.html" target="content">mail_relay_recipient_delete</a></p>
+<p><a href="mail_relay_recipient_get.html" target="content">mail_relay_recipient_get</a></p>
+<p><a href="mail_relay_recipient_update.html" target="content">mail_relay_recipient_update</a></p>
<p><a href="mail_user_add.html" target="content">mail_user_add</a></p>
<p><a href="mail_user_delete.html" target="content">mail_user_delete</a></p>
<p><a href="mail_user_get.html" target="content">mail_user_get</a></p>
--
GitLab