From 54ad81b6cf7c2fabe91efe12fabd588ddb14ebc7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20P=C3=A4tzold?= <paetzold@itc.rwth-aachen.de> Date: Wed, 25 Mar 2020 15:38:42 +0100 Subject: [PATCH] Add some documentation --- Demo/MailAdm-Doku.Tests.ps1 | 4 +++- Demo/MailAdm-Doku.ps1 | 3 --- Demo/connect.ps1 | 2 ++ Demo/distributionlist.ps1 | 2 ++ Demo/listquota.ps1 | 2 ++ Demo/mailaccounts.ps1 | 2 ++ readme.md | 27 +++++++++++++++++++-------- 7 files changed, 30 insertions(+), 12 deletions(-) delete mode 100644 Demo/MailAdm-Doku.ps1 diff --git a/Demo/MailAdm-Doku.Tests.ps1 b/Demo/MailAdm-Doku.Tests.ps1 index 8ba5881..dfa0d74 100644 --- a/Demo/MailAdm-Doku.Tests.ps1 +++ b/Demo/MailAdm-Doku.Tests.ps1 @@ -1,4 +1,6 @@ -# initializing +# These are the Pester Tests in order to demonstrate how the API works + +# initializing # connection settings $user = "<MailAdm Serviceaccount>" $password = "<password>" diff --git a/Demo/MailAdm-Doku.ps1 b/Demo/MailAdm-Doku.ps1 deleted file mode 100644 index 171fad3..0000000 --- a/Demo/MailAdm-Doku.ps1 +++ /dev/null @@ -1,3 +0,0 @@ - - - diff --git a/Demo/connect.ps1 b/Demo/connect.ps1 index f148025..ef44bf3 100644 --- a/Demo/connect.ps1 +++ b/Demo/connect.ps1 @@ -1,3 +1,5 @@ +# functioncall in order to get an active connection to the MailAdm API + function new-mailadmconnection { [CmdletBinding()] param ( diff --git a/Demo/distributionlist.ps1 b/Demo/distributionlist.ps1 index d187dad..12991cd 100644 --- a/Demo/distributionlist.ps1 +++ b/Demo/distributionlist.ps1 @@ -1,3 +1,5 @@ +# functioncalls in order to administer dristributionlists + function create-distributionlist { [CmdletBinding()] param ($WebserviceConnection, $displayname, $mailaddress) diff --git a/Demo/listquota.ps1 b/Demo/listquota.ps1 index c851bc9..8cd01e5 100644 --- a/Demo/listquota.ps1 +++ b/Demo/listquota.ps1 @@ -1,3 +1,5 @@ +#functioncall in order to administer quotapools + function get-quotapool { [CmdletBinding()] param ( diff --git a/Demo/mailaccounts.ps1 b/Demo/mailaccounts.ps1 index d003cc1..2656999 100644 --- a/Demo/mailaccounts.ps1 +++ b/Demo/mailaccounts.ps1 @@ -1,3 +1,5 @@ +#functioncalls in oder to administer mailaddresses + function get-mailaccounts { [CmdletBinding()] param ($webserviceconnection) diff --git a/readme.md b/readme.md index 8e74497..79aaf43 100644 --- a/readme.md +++ b/readme.md @@ -1,20 +1,31 @@ -# Project Title +# MailAdm API -MailAdm API +## Hintergrund -## Getting Started +Das IT Center der RWTH Aachen stellt den zentralen Mailserver bereit. Die Verwaltung der Mailadressen wird durch registrierte Ansprechpartner für die jeweiligen Einrichtungen (Maildomänen) über eine Web Application (MailAdm) vorgenommen. Um die Prozesse zur Pflege von Mailadressen in die internen Abläufe automatisch integrieren zu können, wird neben dem MailAdm auch eine entsprechende, auf SOAP basierende, API angeboten, so dass die Pflege der Mailadressen in die vorhandenen lokalen Prozesse der jeweiligen Einrichtung integriert werden kann. -Das IT Center der RWTH Aachen stellt den zentralen Mailserver bereit. Die Verwaltung der Mailadressen wird durch registrierte Ansprechpartner für die jeweiligen Einrichtungen (Maildomänen) über eine Web Application (MailAdm) vorgenommen. Um die Prozesse zur Pflege von Mailadressen in die internen Abläufe automatisch integrieren zu können, wird neben dem MailAdm auch eine entsprechende API angeboten, so dass die Pflege der Mailadressen in die vorhandenen lokalen Prozesse der jeweiligen Einrichtung integriert werden kann. +### Voraussetzungen -### Prerequisites +Zur Nutzung der MailAdm API benötigen Sie einen Serviceaccount. Diesen können Sie anfordern, indem sie eine Mail an servicedesk@itc.rwth-aachen.de schicken. Derzeit ist unsere Schnittstelle mit der Windows Powershell 5.1 getestet. -Zur Nutzung der MailAdm API benötigen Sie einen Serviceaccount. Diesen können Sie anfordern, indem sie eine Mail an servicedesk@itc.rwth-aachen.de schicken. +## Projektinhalt -## Running the Tests +Das Projekt besteht aus dem Unerverzeichnis Demo, dass beispielhaft den in der API beritgestellten Funktionen zeigt. Hierbei beinhalten die einzelnen Datien folgende Themenblöcke: +1. connect.ps1 +- Verbindungsaufbau zur API +listquota.ps1 +- Funktionsaufrufe zur Verwaltung des Quotapool +mailaccounts.ps1 +- Funktionsaufrufe zur verwaltung von Mailadressen +distributionlist.ps1 +- Funktionsaufrufe zur Verwaltung von Verteilerlisten + +## Ausführung Im Verzeichnis Demo finden Sie entsprechende Unittests, um die Schnittstelle mit Ihrem Serviceaccount zu testen. Bitte passen Sie hierzu in der Datei MailAdm-Doku.Tests.ps1 den Bereich "connection settings" an. +Um die Tests zu starten, wechseln Sie mit in der Windows Powershell ins "Demo" Verzeichnis und starten Sie das Cmdlet invoke-pester -## Authors +## Autoren * **Wilfred Gasper** * **Michael Wirtz** -- GitLab