Jan Ulrich Hasecke
2019-11-06 8d081ac85398030bb1c1f5f6e59e5c995a6987fa
commit | author | age
8d081a 1 .. _kap-modul-emailaddress:
JUH 2
3 ==================
4 Modul emailaddress
5 ==================
6
7 Funktionen
8 ==========
9
10 .. option:: emailaddress.search
11
12    Suche E-Mail-Adresse nach den im Befehlsausdruck angegebenen Feldern und Werten
13
14 .. option:: emailaddress.add
15
16    Füge eine neue E-Mail-Adresse nach den im Befehlsausdruck angegebenen Feldern und Werten hinzu.
17
18 .. option:: emailaddress.update
19
20    Aktualisiere eine E-Mail-Adresse nach den im Befehlsausdruck angegebenen Feldern und Werten.
21
22 .. option:: emailaddress.remove
23
24    Lösche eine E-Mail-Adresse nach den im Befehlsausdruck angegebenen Feldern und Werten.
25    
26 Editierbare Felder
27 ==================
28
29 Das HSAdmin-Modul ``emailaddress`` kann entsprechend der folgenden Befehlssyntax von :command:`HSADmin` Felder setzen oder verändern::
30
31    emailaddress.function({where:{field:'value',...}, set:{field:'value',...}})
32
33 Im Modul ``emailaddress`` stehen folgende Felder zur Verfügung.
34
35 domain
36    Name einer Domain
37 localpart
38    Bezeichnung für den lokalen Teil einer E-Mail-Adresse: der Teil vor ``@``. 
39 target
40    Ziel einer E-Mail-Adresse, mehrere Ziele werden durch Kommata getrennt
0a126d 41
JUH 42
8d081a 43 Beispiele
JUH 44 =========
0a126d 45
JUH 46 .. code-block:: console
47
48     xyz00@hsadmin> emailaddress.search({where:{domain:"hs-example.de"}})
49     xyz00@hsadmin> emailaddress.add ({set:{domain:'hs-example.de',localpart:'info',target:'ihre@emailadresse.de'}})
50
51
8d081a 52 .. todo:: Weitere Beispiele, mindestens noch eins mit where-Kondition