Releases
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 |
Ü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)). Es ermöglicht insbesondere die Umleitung aller E-Mails zu Testzwecken oder auf Testumgebungen sowie die Archivierung aller versandten E-Mails inkl. Dateianhänge zu Dokumentationszwecken.
Version 1.1.2
Beschreibung von Version 1.1.2
Thema | Beschreibung |
---|---|
Email Umleitung | Für den Testbetrieb kann die Email Umleitung aktiviert werden. Dabei werden alle ausgehenden Emails auf eine festgelegte Adresse umgeleitet. In der Email steht zusätzlich, an wen diese eigentlich gegangen wäre. |
Email Protokoll | Alle zu versendenden und alle versendeten Emails werden im Email-Protokoll (unter System) gespeichert. Das Speichern der versendeten Emails kann in den Nucletparametern ausgeschaltet werden. |
Email Queue | Für den Email-Versand gibt es zwei verschiedene Möglichkeiten: Sofort versenden Die Email wird sofort versendet. Ist der Versand von einem Benutzer angestoßen (z.B. durch einen Statuswechsel, der einen Email-Versand auslöst), so muss er warten, bis dieser Vorgang abgeschlossen ist, bevor er weiter arbeiten kann. Kommt es beim Email-Versand zu einem Fehler, so wird die gesamte Aktion (z.B. Statuswechsel) des Benutzers rückgängig gemacht. Versand über Email Queue Die Email wird erst im Email-Protokoll als nicht versendete Email gespeichert und erst durch einen regelmäßig laufenden Job versendet (Administration > Jobsteuerung > Versende Emails). Dieser muss natürlich aktiviert sein. Der Benutzer wird dadurch bei seiner Bearbeitung nicht unnötig lange aufgehalten und ein fehlerhafter Email-Versand führt nicht zum Abbruch seiner Aktion. |
Verwendung in Regeln | Die Klasse EmailVersand stellt zwei Methoden bereit |
Verwendung in der Regelprogrammierung von Version 1.1.2
Klasse EMailVersand | |
---|---|
static void sendMail(EMailContext context) | Versendet die im context definierte Email |
static void sendMailNow(EMailContext context) | Versendet die im context definierte Email sofort, unabhängig von den Einstellungen in den Nucletparametern |
Klasse EMailContext | |
void addRecipient(String address, int type) | Fügt einen Empfänger hinzu (type = To, CC oder BCC) |
void addRecipient(String address) | Fügt einen Empfänger hinzu (To) |
void addRecipients(List<String> lRecipients, int type) | Fügt eine Liste von Empfängern hinzu (type = To, CC oder BCC) |
void addRecipients(List<String> lRecipients) | Fügt eine Liste von Empfängern hinzu (To) |
void addAttachment(NuclosFile file) | Fügt einen Anhang hinzu |
void addAttachments(List<NuclosFile> lAttachments) | Fügt eine Liste von Anhängen hinzu |
void setReplyTo(String replyTo) | Definiert (vom Sender abweichende) Antwortadresse |
void setMessage(String message) | Definiert die Email-Nachricht |
void setSubject(String subject) | Definiert den Email-Betreff |
void setReference(String reference) | Definiert eine Referenz. Das kann z.B. eine Auftragsnummer sein. Die Referenz hat keinen Einfluss auf die Email, hilft aber, Emails im Protokoll wiederzufinden, die zu einem bestimmten Auftrag gehören. |
void resetAttachments() | Leert die Liste der Anhänge |
void resetRecipients() | Leert die Liste der Empfänger |
Beispiel | |
EMailContext context = new EMailContext(); |
Integration von Version 1.1.2
Die Integration nach erfolgtem Nucletimport (siehe Nuclet Import) ist wie folgt vorzunehmen.
Schritt | Beschreibung | Screenshot | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1 | Konfigurieren Sie die Nuclos Parameter für die Nutzung des MailProviders in Nuclos (unter Administration > Parameter):
Siehe dazu auch Email (SMTP/IMAP/Pop3). | |||||||||||||||||||
2 | Konfigurieren Sie die Nuclet Parameter des Nuclets Emailversand (unter Konfiguration > Nuclet Management)
|
Version 1.1.0
Integration / Beschreibung von Version 1.1.0
Die Integration nach erfolgtem Nucletimport (siehe Nuclet Import) ist wie folgt vorzunehmen.
Schritt | Beschreibung |
---|---|
1 | Konfigurieren Sie die, für die Nutzung des MailProviders in Nuclos erforderlichen, SMTP-Systemparameter (mindestens SMTP Authentication, SMTP Username, SMTP Password, SMTP Server, SMTP Sender). Siehe dazu auch Email (SMTP/IMAP/Pop3). |
2 | Konfigurieren Sie die durch Nuclos zu setzende From/ReplyTo-Adresse im Nucletparameter "Email Sender Address". Aktivieren oder deaktivieren Sie desweiteren wie gewünscht die Umleitung in den Nucletparametern "Email Forwarding" ("Y" oder "N") und "Email Forwarding Address". Ist die Umleitung aktiviert, werden alle E-Mails, die über dieses Nuclet versandt werden, nicht an den eigentlichen Empfänger gesandt, sondern an die in "Email Forwarding Address" angegebene Adresse umgeleitet. Auf diese Weise lässt sich die Umsetzung automatisch zu versendender E-Mails in Ihrem eigenen Nuclet einfach testen, bzw. es lässt sich damit ein Testsystem leicht so konfigurieren, dass es keine E-Mails an Ihre Kunden oder Lieferanten sendet. |
3 | Passen Sie die zu verwendende Signatur in der Klasse EMailSignatur an Ihre Anforderungen an. |
4 | Nutzen Sie die neu gewonnene Funktionalität durch Versand von E-Mails z.B. an Ihre Kunden und Lieferanten. Dazu stehen Ihnen folgende Methoden zur Verfügung: EMailVersand.sendEmail(String sRecipient, String sSubject, String sMessage, NuclosFile attachment, String lang) EMailVersand.sendEmail(List<String> lRecipient, String sSubject, String sMessage, NuclosFile attachment, String lang) EMailVersand.sendEmail(List<String> lRecipient, List<String> lRecipientCC, List<String> lRecipientBCC, String sSubject, String sMessage, Über diese Methoden versandte E-Mails werden unter dem Menüpunkt System | E-Mail-Protokoll abgelegt und archiviert. Denken Sie daran, Ihre Anwender bei Bedarf für diesen Menüpunkt lesend zu berechtigen. Beispiel: String sSubject = "Ihre Rechnung"; String sMessage = "Im Anhang erhalten Sie Ihre Rechnung"; (new EMailVersand()).sendEmail(kunde.getEmailadresse(), sSubject, sMessage, pdfInvoice, "de"); |