Seitenhistorie
...
Version | Datum | Hinweise | Kompatibilität |
---|---|---|---|
1.1.0 | 13.02.2018 | Erste veröffentlichte Fassung | ab Nuclos 4.25.1 |
1.1.2 | 04.07.2019 | E-Mail Queue und verbesserte API | ab Nuclos 4.33.8 |
1.1.3 | 17.12.2021 | E-Mail-Templates | ab Nuclos 4.47.3 |
Überblick
Das Nuclet "E-Mail-Versand" bietet zusätzlichen Komfort bei der Nutzung der Nuclos Mail API (siehe http://api.nuclos.de/org/nuclos/api/provider/MailProvider.html#send(org.nuclos.api.mail.NuclosMail)).
...
Außerdem gibt es einen Job zum Empfang von E-Mails.
Version 1.1.3
Beschreibung von Version 1.1.3
Thema | Beschreibung |
---|---|
E-Mail Template | Das BO E-Mail-Template bietet die Möglichkeit, Vorlagen für E-Mails zu erstellen, die dann aus Regeln heraus versendet werden können. Ein Administrator hat damit die Möglichkeit, die von Nuclos versendeten E-Mails selbst zu gestalten und kurzfristig zu ändern. Die Templates bieten hierzu viele Möglichkeiten:
Komplexere E-Mail-Bestandteile, wie z.B. eine Tabelle mit allen Auftragspositionen, müssen durch eine Regel unterstützt werden. |
E-Mail Baustein | Können Bausteine definiert werden, die dann in den E-Mail-Templates zur Verfügung stehen. Möglich sind
Zur Sicherheit lassen sich Bausteine auf bestimmte BO's einschränken, wenn z.B. wenn der Baustein Bearbeiter für die BO's Rechnung und Auftrag existiert, aber nicht für das BO Artikel |
E-Mail Sprache | Definiert die zur Verfügung stehenden Sprachen |
Regelbausteine | Zur Erzeugung einer E-Mail aus einem E-Mail-Template muss eine Instanz einer Klasse mit übergeben werden, die das Interface Regelbausteine implementiert. |
Konfiguration von E-Mail-Templates von Version 1.1.3
Bereich E-Mail-Template | ||
---|---|---|
Name | Pflicht | Eindeutiger Name des Templates |
Basis-Nuclet | optional | Das Nuclet aus dem das Basis-BO kommen soll |
Basis-BO | optional | Das BO, auf das sich die E-Mail bezieht (z.B. Auftrag) |
Empfänger | optional | Ein Regelbaustein, der als Empfänger gekennzeichnet ist und für die die Methode getRecipient() in der Regelbaustein-Implementierung ein Ergebnis mit E-Mail-Adresse, Anrede und ggf. Sprache zurück liefert. |
Footer | optional | Ein als Footer gekennzeichneter Textbaustein |
Signatur | optional | Ein als Signatur gekennzeichneter Textbaustein |
Bereich Weitere Eigenschaften | ||
Sprache (Baustein) | optional | Die Sprache, in der die E-Mail versendet werden soll, definiert durch einen als Sprache gekennzeichneten Textbaustein |
Sprache (statisch) | optional | Die Sprache, in der die E-Mail versendet werden soll, direkt angegeben |
Html? | optional | E-Mail wird im Html-Format versendet (empfohlen) |
Nach Versand löschen? | optional | Sensible E-Mails (z.B. mit Passwort-Links o.ä.) können nach dem Versand automatisch aus dem E-Mail-Protokoll gelöscht werden |
Aktiv? | optional | Aktiviert oder deaktiviert den Versand der E-Mails |
Bereich Template-Test | ||
ID des Basis-BO | optional | Wenn ein Basis-BO angegeben ist, kann hier eine intid angegeben werden, für die die Vorschau erstellt und die Test-E-Mail versendet werden soll |
Sprache | optional | Hier kann die Sprache der Vorschau und der Test-E-Mail forciert werden |
Empfänger der Test-E-Mail | optional | Wenn kein Empfänger angegeben ist, wird die E-Mail an die im Nucletparameter Email Umleitung auf hinterlegte Adresse versendet |
Erzeuge Vorschau | Erzeugt eine Vorschau im Reiter Vorschau | |
Sendet Test-E-Mail | Für den finalen Test kann damit eine Test-E-Mail versendet werden | |
Reiter Konfiguration | ||
Betreff + Nachricht | optional | Hier können Betreff und Nachricht definiert werden. Dabei können verwendet werden
Für Betreff und Nachricht können alternative Texte in anderen Sprachen angegeben werden (siehe Reiter Betreffs(übersetzt) und Nachrichten (übersetzt)) |
Reiter Adressen | optional | Wenn ein Empfänger angegeben ist, wird die E-Mail an die dort ermittelte E-Mail-Adresse versendet. Zusätzlich oder alternativ können weitere Adressen hinzugefügt werden aus
|
Reiter Anhänge | optional | Hier können Anhänge für die E-Mail definiert werden, z.B.
Für jeden Anhang können alternative Anhänge in anderen sprachen definiert werden |
Weitere | ||
Reiter Beschreibung | optional | Hier können weitere Informationen für das Template hinterlegt werden |
Reiter E-Mails | Zeigt die E-Mails an, die bereits aus diesem Template generiert wurden |
Verwendung von E-Mail-Templates von Version 1.1.3
Initialisierung | |
---|---|
Nach dem Nucletimport muss einmal der Job Initialisiere Nuclet Emailversand ausgeführt werden | |
E-Mail-Template | |
Ein E-Mail-Template für eine Rechnung könnte z.B. so aussehen | |
Rechnungsformular als Anhang | |
Regelbaustein für einen Empfänger | |
Das Interface Regelbausteine | |
| |
Beispiel (Text) | |
public String getValue(final String name, final Modifiable<Long> bo, EMailTemplateSprache language, TemplateParameters parameters, RuleContext context) throws BusinessException { throw new BusinessException("Unbekannter Name für einen Regelbaustein: \"" + name + "\""); | |
Beispiel (Empfänger) | |
@Override if (ANSPRECHPARTNER.equals(name)) { throw new BusinessException("Unbekannter Name für einen Empfänger: \"" + name + "\""); | |
Beispiel (Verwendung in Regeln) | |
Einfachster Fall | EMailTemplate template = EMailUtils.getEMailTemplate(Konstanten.EMailTemplate.RECHNUNG); |
In einigen Fällen muss man womöglich noch zu zusätzliche Informationen an das Template weiter geben. Diese geschieht durch parameter. | EMailTemplate template = EMailUtils.getEMailTemplate(Konstanten.EMailTemplate.SERIENNUMMER); |
Version 1.1.2
Beschreibung von Version 1.1.2
...