ks.email

Mit ks.email lassen sich E-Mails versenden, die Verbindung zu einem E-Mail Server testen, sowie eine alte eingegangen E-Mail erneut verarbeiten.

info

ks.email steht nur Serverseitig zur Verfügung

sendEmail

Sendet eine E-Mail mit dem gewünschten Inhalt an die angegebenen Empfänger.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
sender	Objekt	Ja	E-Mail Account mit dem die E-Mail gesendet werden soll
from	Objekt	Ja	Definiert die Anzeige des Senders innerhalb der E-Mail
recipients	String/String Array	Ja	Einzelner Empfänger als String oder mehrere Empfänger als String Array
subject	String/I18n Objekt	Ja	Inhalt des Betreffs. Entweder als simpler String oder I18n Objekt mit der jeweiligen Sprache als key
body	String/I18n Objekt	Ja	Definiert den Hauptinhalt der E-Mail. Entweder als simpler String oder I18n Objekt mit der jeweiligen Sprache als key
attachments	Objekt Array	Nein	Array aus Attachments, die optional mit an die E-Mail gehangen werden können
cc	String Array	Nein	Optionale CC E-Mail-Adressen

Beispiel

In diesem Beispiel wird eine einfache einsprachige E-Mail an Max Mustermann gesendet. Der Sender der E-Mail wird bei Max Mustermann wie folgt angezeigt: "Erika Musterfrau <erika.musterfrau@wspsoft.de>". Würde man den Namen im from Objekt weglassen, würde der Empfänger nur die E-Mail-Adresse des Senders sehen.

const emailAccount = await ks.record.get('EmailAccount', '0003a382-5ea2-4165-922f-26e6d4906597');

await ks.email.sendEmail(emailAccount, {
    name: 'Erika Musterfrau',
    email: emailAccount.email
}, 'max.mustermann@wspsoft.de', 'Das hier ist eine Test E-Mail', 'Bitte ignoriere diese Test E-Mail.');

sendEmailWithNotificationRule

Falls man eine Benachrichtigungsregel manuell losschicken möchte, kann man das mit dieser Funktion tun.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
notificationRuleId	String	Ja	Die Id der zu verwendenden Benachrichtigungsregel
notificationRuleContentId	String	Ja	Die Id des zu verwendenden Benachrichtigungsregelinhalts
record	Objekt	Ja	Der primäre Datensatz der zum Senden verwendet werden soll
templateParams	Objekt	Nein	Optionale Template Parameter die zum interpolieren des Inhalts verwendet werden
emailHeaders	Objekt	Nein	Liste an E-Mail Headern die mit übergeben werden sollen

sendEmailWithReportRule

Falls man eine Report-Definition manuell anstoßen möchte, kann man das mit dieser Funktion tun.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
reportRuleId	String	Ja	Die Id der zu verwendenden Report-Definition
content	String	Ja	Die Id des zu verwendenden Report Inhalts
record	Objekt	Ja	Der primäre Datensatz der zum Senden verwendet werden soll
templateParams	Objekt	Nein	Optionale Template Parameter die zum interpolieren des Inhalts verwendet werden
emailHeaders	Objekt	Nein	Liste an E-Mail Headern die mit übergeben werden sollen

sendMailTemplate

Sendet eine E-Mail mit dem gewünschten Template als Inhalt und interpoliert die Platzhalter des Templates mit allen übergebenen Daten.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
recipients	String/String Array	Ja	Einzelner Empfänger als String oder mehrere Empfänger als String Array
templateNameOrId	String	Ja	Name oder Id der zu verwendenden Nachrichtenvorlage
record	Objekt	Ja	Der primäre Datensatz der zum Interpolieren verwendet werden soll
templateParams	Objekt	Ja	Template Parameter die zum interpolieren des Inhalts verwendet werden
sender	Objekt	Ja	E-Mail Account mit dem die E-Mail gesendet werden soll
attachments	Objekt Array	Nein	Array aus Attachments, die optional mit an die E-Mail gehangen werden können
cc	String Array	Nein	Optionale CC E-Mail-Adressen
emailHeaders	Objekt	Nein	Liste an E-Mail Headern die mit übergeben werden sollen

processEmailMessage

Falls eine eingehende E-Mail nicht korrekt verarbeitet wurde oder man eine spezifische E-Mail nochmal verarbeiten möchte, kann man das mit dieser Funktion machen. Bei Aufruf dieser Funktion werden die eingehende Email Benachrichtigungsregeln, für die passende Tabelle, erneut ausgeführt.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
emailMessage	Objekt	Ja	Die E-Mail die erneut verarbeitet werden soll

testConnection

Die Funktion gibt es als Knopf integriert auf dem E-Mail-Account Layout, falls Sie die Verbindung trotzdem programmatisch Testen wollen, kann testConnection() verwendet werden.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
emailAccount	Objekt	Ja	Der Account für den die Verbindung getestet werden soll