hsscript umgestellt

Jan Ulrich Hasecke

2019-11-06 8d081ac85398030bb1c1f5f6e59e5c995a6987fa

 source/referenz/hsadmin/emailaddress.rst

@@ -1,21 +1,47 @@
==========================
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:

+---------------+------------------------------------------------------------------------+
| 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:
Beispiele
=========

.. code-block:: console

@@ -23,3 +49,4 @@
    xyz00@hsadmin> emailaddress.add ({set:{domain:'hs-example.de',localpart:'info',target:'ihre@emailadresse.de'}})


.. todo:: Weitere Beispiele, mindestens noch eins mit where-Kondition