| 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 | |
| 52 | ||
| 53 | Der folgende Befehl richtet die E-Mail-Adresse ``info@hs-example.de`` mit einer Weiterleitung an die E-Mail-Adresse ``ihre@emailadresse.de`` ein. | |
| 54 | ||
| 55 | .. code-block:: console | |
| 56 | ||
| 57 | xyz00@hsadmin> emailaddress.add ({set:{domain:'hs-example.de',localpart:'info',target:'ihre@emailadresse.de'}}) | |
| 0a126d | 58 | |
| JUH | 59 | |
| 8d081a | 60 | .. todo:: Weitere Beispiele, mindestens noch eins mit where-Kondition |
