Jan Ulrich Hasecke
2019-12-17 4486d578bb789d36a214e62bffbc48081191db5a
commit | author | age
8d081a 1 .. _kap-modul-emailaddress:
JUH 2
3 ==================
4 Modul emailaddress
5 ==================
6
4486d5 7 .. todo:: Komplett überarbeiten nach Best-Practise: Pro Domain ein Domain-Admin.
JUH 8
9
8d081a 10 Funktionen
JUH 11 ==========
12
13 .. option:: emailaddress.search
14
15    Suche E-Mail-Adresse nach den im Befehlsausdruck angegebenen Feldern und Werten
16
17 .. option:: emailaddress.add
18
19    Füge eine neue E-Mail-Adresse nach den im Befehlsausdruck angegebenen Feldern und Werten hinzu.
20
21 .. option:: emailaddress.update
22
23    Aktualisiere eine E-Mail-Adresse nach den im Befehlsausdruck angegebenen Feldern und Werten.
24
25 .. option:: emailaddress.remove
26
27    Lösche eine E-Mail-Adresse nach den im Befehlsausdruck angegebenen Feldern und Werten.
28    
29 Editierbare Felder
30 ==================
31
222551 32 Das HSAdmin-Modul ``emailaddress`` kann entsprechend der folgenden Befehlssyntax von :command:`HSAdmin` Felder setzen oder verändern::
8d081a 33
JUH 34    emailaddress.function({where:{field:'value',...}, set:{field:'value',...}})
35
36 Im Modul ``emailaddress`` stehen folgende Felder zur Verfügung.
37
38 domain
39    Name einer Domain
40 localpart
41    Bezeichnung für den lokalen Teil einer E-Mail-Adresse: der Teil vor ``@``. 
42 target
43    Ziel einer E-Mail-Adresse, mehrere Ziele werden durch Kommata getrennt
0a126d 44
JUH 45
8d081a 46 Beispiele
JUH 47 =========
0a126d 48
81b805 49 Mit dem folgenden Befehl erhalten Sie eine Liste aller E-Mail-Adressen der Domain ``hs-example.de``.
JUH 50
0a126d 51 .. code-block:: console
JUH 52
81b805 53    xyz00@hsadmin> emailaddress.search({where:{domain:"hs-example.de"}})
JUH 54
72c372 55 Mit folgendem Befehl lässt sich eine neue E-Mail-Adresse einrichten und einem Postfach zuordnen: 
81b805 56
72c372 57 .. code-block:: console 
JUH 58
59    xyz00@hsadmin> emailaddress.add ({set:{domain:'hs-example.de',localpart:'info',target:'xyz00-doms'}})
60
61 Das Programm gibt dann folgende Meldung als Quittierung des Befehls zurück:
62
63 .. code-block:: console
55fea1 64
72c372 65    [
JUH 66       {
67          admin:'xyz00-doms',
68          domain:'hs-example.de',
69          emailaddress:'info@hs-example.de',
70          fulldomain:'hs-example.de',
71          id:'88747',
72          localpart:'info',
73          pac:'xyz00',
74          target:[
75             'xyz00-doms'
76          ]
77       }
78    ]
79
80 Wenn später einmal der Wunsch aufkommt, die eintreffenden E-Mails stattdessen an eine externe E-Mail-Adresse weiterzuleiten, kann man den Eintrag aktualisieren. 
81 Das Ziel (``target``) lässt sich entweder ändern:
81b805 82
JUH 83 .. code-block:: console
84
72c372 85    xyz00@hsadmin> emailaddress.update ({where:{domain:'hs-example.de',localpart:'info'}, set:{target:'andere@mail.de'}})
JUH 86    [
87       {
88          admin:'xyz00-doms',
89          domain:'hs-example.de',
90          emailaddress:'info@hs-example.de',
91          fulldomain:'hs-example.de',
92          id:'88747',
93          localpart:'info',
94          pac:'xyz00',
95          target:[
96             'andere@mail.de'
97          ]
98       }
99    ]
100
101 Oder man ergänzt die neue E-Mail-Adresse, indem man sie zusätzlich einfügt.
102 Mehrere Ziele werden mit Kommata abgegrenzt.
103
104 .. code-block:: console
105
106    xyz00@hsadmin> emailaddress.update ({where:{domain:'hs-example.de',localpart:'info'}, set:{target:'andere@mail.de,xzy00-doms'}})
107    [
108       {
109          admin:'xyz00-doms',
110          domain:'hs-example.de',
111          emailaddress:'info@hs-example.de',
112          fulldomain:'hs-example.de',
113          id:'88747',
114          localpart:'info',
115          pac:'xyz00',
116          target:[
117             'andere@mail.de',
222551 118             'xzy00@hs-example.de'
72c372 119          ]
JUH 120       }
121    ]
0a126d 122
JUH 123