edit | blame | history | raw

.. _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

Beispiele

.. 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'}})

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