Peter Hormanns
2019-12-09 9f8db658bf07b13c3f7051e7bce8b678c2cfd453
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
222551 29 Das HSAdmin-Modul ``emailaddress`` kann entsprechend der folgenden Befehlssyntax von :command:`HSAdmin` Felder setzen oder verändern::
8d081a 30
JUH 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
55fea1 61
72c372 62    [
JUH 63       {
64          admin:'xyz00-doms',
65          domain:'hs-example.de',
66          emailaddress:'info@hs-example.de',
67          fulldomain:'hs-example.de',
68          id:'88747',
69          localpart:'info',
70          pac:'xyz00',
71          target:[
72             'xyz00-doms'
73          ]
74       }
75    ]
76
77 Wenn später einmal der Wunsch aufkommt, die eintreffenden E-Mails stattdessen an eine externe E-Mail-Adresse weiterzuleiten, kann man den Eintrag aktualisieren. 
78 Das Ziel (``target``) lässt sich entweder ändern:
81b805 79
JUH 80 .. code-block:: console
81
72c372 82    xyz00@hsadmin> emailaddress.update ({where:{domain:'hs-example.de',localpart:'info'}, set:{target:'andere@mail.de'}})
JUH 83    [
84       {
85          admin:'xyz00-doms',
86          domain:'hs-example.de',
87          emailaddress:'info@hs-example.de',
88          fulldomain:'hs-example.de',
89          id:'88747',
90          localpart:'info',
91          pac:'xyz00',
92          target:[
93             'andere@mail.de'
94          ]
95       }
96    ]
97
98 Oder man ergänzt die neue E-Mail-Adresse, indem man sie zusätzlich einfügt.
99 Mehrere Ziele werden mit Kommata abgegrenzt.
100
101 .. code-block:: console
102
103    xyz00@hsadmin> emailaddress.update ({where:{domain:'hs-example.de',localpart:'info'}, set:{target:'andere@mail.de,xzy00-doms'}})
104    [
105       {
106          admin:'xyz00-doms',
107          domain:'hs-example.de',
108          emailaddress:'info@hs-example.de',
109          fulldomain:'hs-example.de',
110          id:'88747',
111          localpart:'info',
112          pac:'xyz00',
113          target:[
114             'andere@mail.de',
222551 115             'xzy00@hs-example.de'
72c372 116          ]
JUH 117       }
118    ]
0a126d 119
JUH 120