2020.06 2021.06

Mail Connector

Die Seite beschreibt die Möglichkeiten, aus MyCoRe heraus Mails zu versenden.

MCRMailer

Die Klasse org.mycore.common.MCRMailer gestatte es, aus der MyCoRe-Anwendung heraus Mails zu generieren und zu versenden. Eine entsprechende API ist implementiert. Dafür sind die folgenden Konfigurationsmöglichkeiten vorgesehen:

  • MCR.Mail.Debug=false - boolscher Wert zum Einschalten zusätzlicher Debug-Informationen; Standard ist false
  • MCR.Mail.Encoding=UTF-8 - das Encoding für die Mail; Standard ist UTF-8
  • MCR.Mail.NumTries=1 - Anzahl der Versuche, die mail abzuschicken; Standard ist 1
  • MCR.Mail.Password={Passwort im Mailserver} - das Password für den Kontakt zum Mailserver - dieses Property wird nur genutzt, wenn das Mail-Server-Konzept der Host-Einrichtung es für den Zugang zum Server erfordert.
  • MCR.Mail.Port=25 - Port des Mailers; Standard ist Port 25
  • MCR.Mail.Protocol=smtp - das Mail-Transportprotokoll; Standard ist smtp
  • MCR.Mail.Recipients={address@recipient1,...} - die Adresse(n) der Mail-Empfänger
  • MCR.Mail.Sender={address@sender} - die Adresse des Mail-Senders
  • MCR.Mail.Server={Hostname des Mail-Servers}
  • MCR.Mail.User={Benutzer im Mailserver} - Das Benutzer-Login für den Kontakt zum Mailserver - dieses Property wird nur genutzt, wenn das Mail-Server-Konzept der Host-Einrichtung es für den Zugang zum Server erfordert.
  • MCR.Mail.STARTTLS={disabled|enabled|required} - Ob STARTTLS verwendet werden soll (sofern der Serves dies unterstützt) bzw. verwendet werden muss.

MCRMailEventHandler

Der MCRMailEventHandler ist Bestandteil der MyCoRe-Workflow-Komponente (wfc). Er wird über die Index-Nummer 900 des EventHandlers angesprochen. Die Konfiguration erfolgt einerseit über die oben genannten Properties, andererseits über eine XML-Steue- und Nachrichtendatei, welche über das Stylesheet e-mail-events.xsl generiert wird. Diese Datei ist unbedingt erforderlich.

Da es je nach Anwendung verschiedenste Szenarien für die Gestaltung der Mail gibt, soll an dieser Stelle nur auf Lösungen verwiesen werden. Bedingt durch die Nutzung innerhalb der EventHandler-Kette sind folgende Aktionen und Datentypen nutzbar:

  • Datentyp : mycoreobject, mycorederivate, mcrpath
  • Aktionen : create, update, delete, repair

Generischer Ansatz

Unter den folgenden Referenzen ist ein generischer minimalistischer Ansatz für das Konfigurations-File zu finden. Dabei erfolgt die Ergänzung für das konkrete Datenmodell über das Property MCR.URIResolver.xslIncludes.eventHandlerMailer=%MCR.URIResolver.xslIncludes.eventHandlerMailer%,e-mail-events-myihs2.xsl

generisches Basis-Stylesheet aus Leipzig

Ergänzung für ein konkretes Datenmodell aus Leipzig

Spezielle Lösung für MIR und andere komplexe Systeme

Für die Anwendung MIR wurde ein spezielles Stylesheet entwickelt, welches die vielen Details der MIR-Applikation berücksichtigt und einen dediziertem Mail-Versand gestattet.

Hier die umfangreiche Lösung von MIR