Zum Hauptinhalt springen
Der Knoten newsletter bündelt alles rund um Newsletter An- und Abmeldung sowie die dazugehörigen E-Mails. Hier kann beispielsweise festgelegt werden, ob eine Bestätigung (Double-Opt-In) für verschiedene Aktionen nötig ist und wie die E-Mail-Formulare dargestellt werden und was sie beinhalten sollen.

​
newsletter*-Grundstruktur

Nachfolgend der Grundaufbau des Knotens newsletter 
{
  "newsletter": {
    "field": { },
    "newsletter": { },
  }
}
Parameterbeschreibung
ParamterBeschreibung
fieldDefiniert ein einzelnes Feld für das Newsletter-Formular.
newsletterDefiniert grundlegende Newsletter-Funktionen.

​
newsletter.field - Formularfeld für Newsletter

Der Knoten newsletter.field definiert ein einzelnes Feld des Newsletter-Formulars. Man legt damit beispielsweise die Bezeichnung, den Feldtyp sowie Validierungen fest. Das Frontend rendert die Eingabe entsprechend dieser Vorgaben. Beispielkonfiguration (Feld “Vorname” hinzufügen) 
{
  "newsletter": {
    "fields": {
      "firstName": {
        "name": "firstName",
        "label": "<Textbaustein>",
        "required": false,
        "type": "text",
        "validations": [
          {
            "service": "formCheck.minlen",
            "options": {
              "len": 3
            }
          },
          {
            "service": "formCheck.maxlen",
            "options": {
              "len": 50
            }
          }
        ]
      }
    }
  }
}
Parameterbeschreibung
ParameterTypBeschreibung
namestringTechnischer Name des Formularfeldes.
Muss eindeutig sein und ist selbst wählbar.
Wird beim Absenden des Formulars sowie beim Import / Export verwendet.
labelstringAnzeigename im Admin-Interface.

requiredboolMarkiert das Feld als Pflichtfeld.
Default: true
typeenumGibt den Feldtyp an.
Mögliche Werte:
- text - Freitextfeld
- salutation - Auswahl einer im Shop konfigurierten Anrede
- title - Auswahl eines im Shop konfigurierten Titels
validationsmultiServiceListe von Validierungsregeln zur Prüfung des Feldinhalts.
Wird nur bei Freitextfeldern (type: text ) unterstützt.
Mehr unter Validierungs- und Prüfservices
Target: inputValidation

​
newsletter.newsletter - Newsletter Einstellungen

Der Knoten newsletter.newsletter steuert alle grundlegenden Newsletter-Funktionen, zum Beispiel Double-Opt-In und An-/Abmeldung. Es können Templates, Betreffzeilen, Absenderangaben uvm. bestimmt werden. Beispielkonfiguration 
{
  "blacklistSelfDoubleOptIn": true,
  "doubleOptInEmailBlacklist": {
    "fromAddress": "no-reply@websale.de",
    "fromName": "WEBSALE",
    "subject": "Bestätigen Sie Ihre Blacklist Anmeldung",
    "template": "newsletterBlacklist.htm"
  },
  "doubleOptInEmailSubscribe": {
    "fromAddress": "no-reply@websale.de",
    "fromName": "WEBSALE",
    "subject": "Bestätigen Sie Ihre Registrierung",
    "template": "newsletterSubscribe.htm"
  },
  "doubleOptInEmailUnsubscribe": {
    "fromAddress": "no-reply@websale.de",
    "fromName": "WEBSALE",
    "subject": "Bestätigen Sie Ihre Abmeldung",
    "template": "newsletterUnsubscribe.htm"
  },
  "fields": [
    "newsletter.field.firstName",
    "newsletter.field.lastName",
    "newsletter.field.salutation"
  ],
  "importSubscribeDoubleOptIn": true,
  "unsubscribeAdminDoubleOptIn": true,
  "unsubscribeSelfDoubleOptIn": true,
  "welcomeEmail": {
    "fromAddress": "no-reply@websale.de",
    "fromName": "WEBSALE",
    "subject": "Herzlich Willkommen im Newsletter",
    "template": "newsletterWelcome.htm"
  }
}
Parameterbeschreibung
ParameterTypBeschreibung
blacklistSelfDoubleOptInboolWenn sich jemand selbst vom Newsletter abmelden möchte, muss er dies per Bestätigungs-E-Mail (Double-Opt-In) bestätigen.
default: true
doubleOptInEmailBlacklistobjectEinstellungen für die Bestätigungs-E-Mail bei Abmeldung / Sperrung.
fromAddressstringAbsender E-Mail der Bestätigungsmail.
fromNamestringAbsendername der Bestätigungsmail.
subjectstringBetreff der Bestätigungsmail.
templatestringName / Datei des E-Mail-Templates, das verwendet werden soll.
doubleOptInEmailSubscribeobjectEinstellungen für die Bestätigungs-E-Mail bei Anmeldung zum Newsletter.
fromAddressstringAbsender E-Mail der Anmeldemail.
fromNamestringAbsendername der Anmeldemail.
subjectstringBetreff der Anmeldemail.
templatestringName / Datei des E-Mail-Templates, das verwendet werden soll.
doubleOptInEmailUnsubscribeobjectEinstellung für die Bestätigungs-E-Mail bei der Abmeldung vom Newsletter.
fromAddressstringAbsender E-Mail der Abmeldungsmail.
fromNamestringAbsendername der Abmeldungsmail.
subjectstringBetreff der Abmeldungsmail.
templatestringName / Datei des E-Mail-Templates, das verwendet werden soll.
fieldsmultiAssocVerknüpfte Formularfelder für die Anmeldung zum Newsletter.
Hier werden die unter newsletter.field definierten Felder referenziert.
Ein eigenes Feld für E-Mail-Adresse muss nicht angegeben werden - diese wird stets automatisch unter dem Namen email übergeben.
target: newsletter.field
importSubscribeDoubleOptInboolAuch importierte E-Mail-Adressen müssen ihre Anmeldung zum Newsletter per Bestätigungs-E-Mail bestätigen.
default: true
unsubscribeAdminDoubleOptInboolWenn ein Administrator jemanden vom Newsletter abmeldet, muss der Empfänger die Abmeldung per Bestätigungs-E-Mail bestätigen.
default: true
unsubscribeSelfDoubleOptInboolBei eigener Abmeldung vom Newsletter ist eine Abmeldung per Bestätigungs-E-Mail nötig.
default: true
welcomeEmailobjectEinstellungen für die Willkommens-E-Mail nach erfolgreich Anmeldung zum Newsletter.
fromAddressstringAbsender E-Mail der Willkommensmail.
fromNamestringAbsendername der Willkommensmail.
subjectstringBetreff der Willkommensmail.
templatestringName / Datei des E-Mail-Templates, das verwendet werden soll.