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