Jan Ulrich Hasecke
2019-11-28 72c372f51a0c2f29d2247397ed9b8cacdf2ce179
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
81b805 46 Mit dem folgenden Befehl erhalten Sie eine Liste aller E-Mail-Adressen der Domain ``hs-example.de``.
JUH 47
0a126d 48 .. code-block:: console
JUH 49
81b805 50    xyz00@hsadmin> emailaddress.search({where:{domain:"hs-example.de"}})
JUH 51
72c372 52 Mit folgendem Befehl lässt sich eine neue E-Mail-Adresse einrichten und einem Postfach zuordnen: 
81b805 53
72c372 54 .. code-block:: console 
JUH 55
56    xyz00@hsadmin> emailaddress.add ({set:{domain:'hs-example.de',localpart:'info',target:'xyz00-doms'}})
57
58 Das Programm gibt dann folgende Meldung als Quittierung des Befehls zurück:
59
60 .. code-block:: console
61    [
62       {
63          admin:'xyz00-doms',
64          domain:'hs-example.de',
65          emailaddress:'info@hs-example.de',
66          fulldomain:'hs-example.de',
67          id:'88747',
68          localpart:'info',
69          pac:'xyz00',
70          target:[
71             'xyz00-doms'
72          ]
73       }
74    ]
75
76 Wenn später einmal der Wunsch aufkommt, die eintreffenden E-Mails stattdessen an eine externe E-Mail-Adresse weiterzuleiten, kann man den Eintrag aktualisieren. 
77 Das Ziel (``target``) lässt sich entweder ändern:
81b805 78
JUH 79 .. code-block:: console
80
72c372 81    xyz00@hsadmin> emailaddress.update ({where:{domain:'hs-example.de',localpart:'info'}, set:{target:'andere@mail.de'}})
JUH 82    [
83       {
84          admin:'xyz00-doms',
85          domain:'hs-example.de',
86          emailaddress:'info@hs-example.de',
87          fulldomain:'hs-example.de',
88          id:'88747',
89          localpart:'info',
90          pac:'xyz00',
91          target:[
92             'andere@mail.de'
93          ]
94       }
95    ]
96
97 Oder man ergänzt die neue E-Mail-Adresse, indem man sie zusätzlich einfügt.
98 Mehrere Ziele werden mit Kommata abgegrenzt.
99
100 .. code-block:: console
101
102    xyz00@hsadmin> emailaddress.update ({where:{domain:'hs-example.de',localpart:'info'}, set:{target:'andere@mail.de,xzy00-doms'}})
103    [
104       {
105          admin:'xyz00-doms',
106          domain:'hs-example.de',
107          emailaddress:'info@hs-example.de',
108          fulldomain:'hs-example.de',
109          id:'88747',
110          localpart:'info',
111          pac:'xyz00',
112          target:[
113             'andere@mail.de',
114             'xzy00-hs-example.de'
115          ]
116       }
117    ]
0a126d 118
JUH 119