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

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"}})

Mit folgendem Befehl lässt sich eine neue E-Mail-Adresse einrichten und einem Postfach zuordnen:

.. code-block:: console

xyz00@hsadmin emailaddress.add ({set:{domain:'hs-example.de',localpart:'info',target:'xyz00-hs_example.de'}})

Das Programm gibt dann folgende Meldung als Quittierung des Befehls zurück:

.. code-block:: console

[
{
admin:'xyz00-doms',
domain:'hs-example.de',
emailaddress:'info@hs-example.de',
fulldomain:'hs-example.de',
id:'88747',
localpart:'info',
pac:'xyz00',
target:[
'xyz00-hs_example.de'
]
}
]

Wenn später einmal der Wunsch aufkommt, die eintreffenden E-Mails stattdessen an eine externe E-Mail-Adresse weiterzuleiten, kann man den Eintrag aktualisieren.
Das Ziel (target) lässt sich entweder ändern:

.. code-block:: console

xyz00@hsadmin emailaddress.update ({where:{domain:'hs-example.de',localpart:'info'}, set:{target:'andere@mail.de'}})
[
{
admin:'xyz00-doms',
domain:'hs-example.de',
emailaddress:'info@hs-example.de',
fulldomain:'hs-example.de',
id:'88747',
localpart:'info',
pac:'xyz00',
target:[
'andere@mail.de'
]
}
]

Oder man ergänzt die neue E-Mail-Adresse, indem man sie zusätzlich einfügt.
Mehrere Ziele werden mit Kommata abgegrenzt.

.. code-block:: console

xyz00@hsadmin emailaddress.update ({where:{domain:'hs-example.de',localpart:'info'}, set:{target:'andere@mail.de,xzy00-hs_example.de'}})
[
{
admin:'xyz00-doms',
domain:'hs-example.de',
emailaddress:'info@hs-example.de',
fulldomain:'hs-example.de',
id:'88747',
localpart:'info',
pac:'xyz00',
target:[
'andere@mail.de',
'xzy00-hs_example.de'
]
}
]