Jan Ulrich Hasecke
2019-11-19 81b8056b00cef72c1b154d20aca7939721795b66
source/referenz/hsadmin/emailaddress.rst
@@ -1,25 +1,60 @@
==========================
HSAdmin-Modul emailaddress
==========================
.. _kap-modul-emailaddress:
==================
Modul emailaddress
==================
Funktionen
==========
.. option:: emailaddress.search
   Suche E-Mail-Adresse nach den im Befehlsausdruck angegebenen Feldern und Werten
.. option:: emailaddress.add
   Füge eine neue E-Mail-Adresse nach den im Befehlsausdruck angegebenen Feldern und Werten hinzu.
.. option:: emailaddress.update
   Aktualisiere eine E-Mail-Adresse nach den im Befehlsausdruck angegebenen Feldern und Werten.
.. option:: emailaddress.remove
   Lösche eine E-Mail-Adresse nach den im Befehlsausdruck angegebenen Feldern und Werten.
Editierbare Felder
==================
Das HSAdmin-Modul ``emailaddress`` kann entsprechend der folgenden Befehlssyntax von :command:`HSADmin` Felder setzen oder verändern::
   emailaddress.function({where:{field:'value',...}, set:{field:'value',...}})
Im Modul ``emailaddress`` stehen folgende Felder zur Verfügung.
domain
   Name einer Domain
localpart
   Bezeichnung für den lokalen Teil einer E-Mail-Adresse: der Teil vor ``@``.
target
   Ziel einer E-Mail-Adresse, mehrere Ziele werden durch Kommata getrennt
Das HSAdmin-Modul ``emailaddress`` verfügt über folgende Optionen:
Beispiele
=========
+---------------+------------------------------------------------------------------------+
| Option        | Erläuterung                                                            |
+===============+========================================================================+
| domain        | Name einer  Domain                                                     |
+---------------+------------------------------------------------------------------------+
| localpart     | bezeichnet den lokalen  Part einer Domain (Part vor '@')               |
+---------------+------------------------------------------------------------------------+
| target        | Ziel einer E-Mail-Adresse, mehrere Ziele werden durch Kommata getrennt |
+---------------+------------------------------------------------------------------------+
Beispiele:
Mit dem folgenden Befehl erhalten Sie eine Liste aller E-Mail-Adressen der Domain ``hs-example.de``.
.. code-block:: console
    xyz00@hsadmin> emailaddress.search({where:{domain:"hs-example.de"}})
    xyz00@hsadmin> emailaddress.add ({set:{domain:'hs-example.de',localpart:'info',target:'ihre@emailadresse.de'}})
   xyz00@hsadmin> emailaddress.search({where:{domain:"hs-example.de"}})
Der folgende Befehl richtet die E-Mail-Adresse ``info@hs-example.de`` mit einer Weiterleitung an die E-Mail-Adresse ``ihre@emailadresse.de`` ein.
.. code-block:: console
   xyz00@hsadmin> emailaddress.add ({set:{domain:'hs-example.de',localpart:'info',target:'ihre@emailadresse.de'}})
.. todo:: Weitere Beispiele, mindestens noch eins mit where-Kondition