| 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 | ||
| 222551 | 77 | .. todo:: MOS: Der Code-Block oben wird in der HTML-Ansicht nicht angezeigt, fehlt evtl. eine Leerzeile nach code-block:: console? |
| MOS | 78 | |
| 72c372 | 79 | Wenn später einmal der Wunsch aufkommt, die eintreffenden E-Mails stattdessen an eine externe E-Mail-Adresse weiterzuleiten, kann man den Eintrag aktualisieren. |
| JUH | 80 | Das Ziel (``target``) lässt sich entweder ändern: |
| 81b805 | 81 | |
| JUH | 82 | .. code-block:: console |
| 83 | ||
| 72c372 | 84 | xyz00@hsadmin> emailaddress.update ({where:{domain:'hs-example.de',localpart:'info'}, set:{target:'andere@mail.de'}}) |
| JUH | 85 | [ |
| 86 | { | |
| 87 | admin:'xyz00-doms', | |
| 88 | domain:'hs-example.de', | |
| 89 | emailaddress:'info@hs-example.de', | |
| 90 | fulldomain:'hs-example.de', | |
| 91 | id:'88747', | |
| 92 | localpart:'info', | |
| 93 | pac:'xyz00', | |
| 94 | target:[ | |
| 95 | 'andere@mail.de' | |
| 96 | ] | |
| 97 | } | |
| 98 | ] | |
| 99 | ||
| 100 | Oder man ergänzt die neue E-Mail-Adresse, indem man sie zusätzlich einfügt. | |
| 101 | Mehrere Ziele werden mit Kommata abgegrenzt. | |
| 102 | ||
| 103 | .. code-block:: console | |
| 104 | ||
| 105 | xyz00@hsadmin> emailaddress.update ({where:{domain:'hs-example.de',localpart:'info'}, set:{target:'andere@mail.de,xzy00-doms'}}) | |
| 106 | [ | |
| 107 | { | |
| 108 | admin:'xyz00-doms', | |
| 109 | domain:'hs-example.de', | |
| 110 | emailaddress:'info@hs-example.de', | |
| 111 | fulldomain:'hs-example.de', | |
| 112 | id:'88747', | |
| 113 | localpart:'info', | |
| 114 | pac:'xyz00', | |
| 115 | target:[ | |
| 116 | 'andere@mail.de', | |
| 222551 | 117 | 'xzy00@hs-example.de' |
| 72c372 | 118 | ] |
| JUH | 119 | } |
| 120 | ] | |
| 0a126d | 121 | |
| JUH | 122 | |
