Newsletter

In diesem Abschnitt werden die verfügbaren Aktionen im Bereich Newsletter beschrieben. Mithilfe dieser Aktionen können Kunden den Newsletter abonnieren, ihre Anmeldung bestätigen, sich wieder abmelden oder ihre E-Mail-Adresse für den Newsletter-Versand sperren lassen.

Aktionen im Überblick

Aktion	Beschreibung
`NewsletterSubscribe`	Meldet einen Kunden für den Newsletter an.
`NewsletterSubscribeConfirm`	Bestätigt die Newsletter-Anmeldung per Double-Opt-In.
`NewsletterUnsubscribe`	Meldet einen Kunden vom Newsletter ab.
`NewsletterUnsubscribeConfirm`	Bestätigt die Newsletter-Abmeldung per Double-Opt-In.
`BlacklistAdd`	Setzt eine E-Mail-Adresse auf die Blacklist.
`BlacklistAddConfirm`	Bestätigt den Eintrag in die Blacklist per Double-Opt-In.

Aktionen

NewsletterSubscribe

Mit dieser Aktion wird ein Kunde für den Newsletter angemeldet. Nach erfolgreicher Anmeldung erhält der Kunde eine Bestätigungs-E-Mail mit einem Double-Opt-In Link. Anwendungsbeispiel
Nutzbar auf einer Newsletter-Anmeldeseite, auf der Kunden ihre E-Mail-Adresse und optional eine oder mehrere Zielgruppen auswählen können. Parameter

Name	Beschreibung
`email`	Die E-Mail-Adresse, die für den Newsletter angemeldet werden soll.
`targetGroupId.(id)`	Optionale Zielgruppen-ID, für die der Kunde angemeldet werden soll.

Fehlercodes

Fehlercode	Beschreibung
`missingEmail`	Parameter `email` fehlt.
`emailCheckFailed`	Die angegebene E-Mail-Adresse ist ungültig.
`accountAlreadyExists`	Die E-Mail-Adresse ist bereits für den Newsletter angemeldet.

Zugehörige Module, Variablen & Methoden

Beispiel das zeigt, wie ein Kunde seine E-Mail-Adresse und optional Zielgruppen auswählt, um den Newsletter zu abonnieren, inklusive Erfolgsausgabe nach der Anmeldung.

{{ var $myActionNewsletterSubscribe = $wsActions.create("NewsletterSubscribe") }}
<form method="post" action="{{= $wsViews.current.url() }}">
    <input type="hidden" name="wscsrf" value="{{= $myActionNewsletterSubscribe.csrf }}">
    <input type="hidden" name="wsact" value="{{= $myActionNewsletterSubscribe.id }}">
    {{ if $myActionNewsletterSubscribe.success }}
        <div class="alert alert-success">Newsletter erfolgreich abonniert.</div>
    {{ /if }}
    {{ foreach $myNewsletterList in $wsNewsletter.getTargetGroups() }}
        <input type="checkbox" value="{{= $myNewsletterList.id }}" name="targetGroupId.{{= $myNewsletterList.id }}">
        <label>{{= $myNewsletterList.name }}</label>
    {{ /foreach }}
    <input type="email" name="email">
    <button type="submit">Newsletter abonnieren</button>
</form>

NewsletterSubscribeConfirm

Mit dieser Aktion wird die Newsletter-Anmeldung per Double-Opt-In bestätigt. Der Kunde erhält nach der Anmeldung eine E-Mail mit einem Bestätigungslink, über den diese Aktion ausgelöst wird. Bei einer normalen Anmeldung legt die Aktion entweder einen neuen Abonnenten an oder ergänzt einen bestehenden Abonnenten mit derselben E-Mail-Adresse um die gewählten Zielgruppen. Anschließend wird die Adresse von der Blacklist entfernt und die Willkommens-E-Mail versendet. Anwendungsbeispiel
Nutzbar auf der Bestätigungsseite, auf die der Kunde nach Klick auf den Opt-In-Link in der Anmelde-E-Mail weitergeleitet wird. Bestätigung einer geänderten E-Mail-Adresse Wird die E-Mail-Adresse eines Abonnenten über PUT newsletter/subscriber/{id} geändert, erhält die neue Adresse ebenfalls eine E-Mail mit dem Token confirmSubscribeNewsletter. Dieser Token enthält zusätzlich den Parameter subscriberId mit der ID des bestehenden Abonnenten. Enthält der Token eine subscriberId, wird kein neuer Abonnent angelegt. Stattdessen wird die bestätigte E-Mail-Adresse dem bestehenden Abonnenten zugewiesen:

Situation	Ergebnis
Der Abonnent existiert und die Adresse ist frei	Die E-Mail-Adresse des Abonnenten wird ersetzt und in der Änderungshistorie protokolliert. Zielgruppen und Newsletterfelder bleiben unverändert. Die Adresse wird von der Blacklist entfernt. Es wird keine Willkommens-E-Mail versendet. Die Aktion ist erfolgreich.
Die Adresse gehört inzwischen einem anderen Abonnenten	Es wird nichts geändert. Die Aktion ist trotzdem erfolgreich.
Der Abonnent wurde inzwischen gelöscht oder die Änderung schlägt fehl	Die Aktion meldet den Fehlercode `internalError`.

Token ohne subscriberId, beispielsweise aus einer Anmeldung über die Funktion NewsletterSubscribe oder aus E-Mails, die vor der Einführung dieses Parameters versendet wurden, werden weiterhin wie normale Anmeldungen verarbeitet. Fehlercodes Die Fehlertexte werden in actions.newsletterSubscribe gepflegt.

Fehlercode	Beschreibung
`actionNotAllowed`	Es wurde kein gültiger Opt-In-Token für diese Aktion übergeben.
`internalError`	Der Token enthält keine E-Mail-Adresse oder keine Zielgruppe, die Abonnentendaten konnten nicht geladen werden oder die E-Mail-Adresse konnte nicht auf den bestehenden Abonnenten übertragen werden.

Zugehörige Module, Variablen & Methoden

$wsNewsletter

Beispiel das zeigt, wie nach erfolgreicher Bestätigung eine Erfolgsmeldung angezeigt wird und bei einem ungültigen Token ein Fehlerhinweis erscheint.

{{ var $myActionNewsletterSubscribeConfirm = $wsActions.create('NewsletterSubscribeConfirm') }}
<form method="post" action="{{= $wsViews.current.url() }}">
    <input type="hidden" name="wscsrf" value="{{= $myActionNewsletterSubscribeConfirm.csrf }}">
    <input type="hidden" name="wsact" value="{{= $myActionNewsletterSubscribeConfirm.id }}">
    {{ if $myActionNewsletterSubscribeConfirm.success }}
        <div class="alert alert-success">Newsletter erfolgreich abonniert.</div>
    {{ else }}
        {{ include "components/errorAlert.htm" with $cAction = $cActionNewsletterSubscribeConfirm }}
        <button type="submit">Anmeldung bestätigen.</button>
    {{ /if }}
</form>

NewsletterUnsubscribe

Mit dieser Aktion wird ein Kunde vom Newsletter abgemeldet. Der Kunde gibt dabei seine E-Mail-Adresse an und kann optional einzelne Zielgruppen abwählen. Anwendungsbeispiel
Nutzbar auf der Abmeldeseite, auf der Kunden ihre E-Mail-Adresse eingeben und sich von einzelnen oder allen Newsletter-Zielgruppen abmelden können. Parameter

Name	Beschreibung
`email`	Die E-Mail-Adresse, die vom Newsletter abgemeldet werden soll.
`targetGroupId.(id)`	Optionale Zielgruppen-ID, von der der Kunde abgemeldet werden soll.

Fehlercodes

Fehlercode	Beschreibung
`missingEmail`	Parameter `email` fehlt.
`emailCheckFailed`	Die angegebene E-Mail-Adresse ist ungültig.

Zugehörige Module, Variablen & Methoden

Beispiel das zeigt, wie ein Kunde seine E-Mail-Adresse eingibt und sich von einzelnen Zielgruppen abmeldet, inklusive Erfolgsausgabe.

{{ var $myActionNewsletterUnsubscribe = $wsActions.create('NewsletterUnsubscribe') }}
<form method="post" action="{{= $wsViews.current.url() }}">
    <input type="hidden" name="wscsrf" value="{{= $myActionNewsletterUnsubscribe.csrf }}">
    <input type="hidden" name="wsact" value="{{= $myActionNewsletterUnsubscribe.id }}">
    {{ if $cActionNewsletterUnsubscribe.success }}
        <div class="alert alert-success">Erfolgreich vom Newsletter abgemeldet.</div>
    {{ else }}
        <input type="email" name="email" value="{{= $myActionNewsletterUnsubscribe.params.email | ifNull('') }}">
        {{ foreach $group in $wsNewsletter.getTargetGroups() }}
            {{ if not $group.deactivated }}
                <input type="checkbox" name="targetGroupId.{{= $group.id }}" value="y">
                <label>{{= $group.name }}</label>
            {{ /if }}
        {{ /foreach }}
        <button type="submit">Vom Newsletter abmelden.</button>
    {{ /if }}
</form>

NewsletterUnsubscribeConfirm

Mit dieser Aktion wird die Newsletter-Abmeldung per Double-Opt-In bestätigt. Der Kunde erhält nach der Abmeldung eine E-Mail mit einem Bestätigungslink, über den diese Aktion ausgelöst wird. Anwendungsbeispiel
Nutzbar auf der Bestätigungsseite, auf die der Kunde nach Klick auf den Opt-In-Link in der Abmelde-E-Mail weitergeleitet wird. Fehlercodes Die Fehlertexte werden in actions.newsletterUnsubscribe gepflegt.

Fehlercode	Beschreibung
`actionNotAllowed`	Es wurde kein gültiger Opt-In-Token für diese Aktion übergeben.
`internalError`	Der Token enthält keine E-Mail-Adresse oder keine Zielgruppe.

Zugehörige Module, Variablen & Methoden

$wsNewsletter

Beispiel das zeigt, wie nach erfolgreicher Bestätigung der Abmeldung eine Erfolgsmeldung angezeigt wird und bei einem ungültigen Token ein Fehlerhinweis erscheint.

{{ var $myActionNewsletterUnsubscribeConfirm = $wsActions.create('NewsletterUnsubscribeConfirm') }}
<form method="post" action="{{= $wsViews.current.url() }}">
    <input type="hidden" name="wscsrf" value="{{= $myActionNewsletterUnsubscribeConfirm.csrf }}">
    <input type="hidden" name="wsact" value="{{= $myActionNewsletterUnsubscribeConfirm.id }}">
    {{ if $cActionNewsletterUnsubscribeConfirm.success }}
        <div class="alert alert-success">Erfolgreich vom Newsletter abgemeldet.</div>
    {{ else }}
        <button type="submit">Abmeldung bestätigen.</button>
    {{ /if }}
</form>

BlacklistAdd

Mit dieser Aktion wird eine E-Mail-Adresse auf die Blacklist (Sperrliste) gesetzt. An Adressen auf dieser Liste versendet der Shop keine Newsletter. Die Sperre gilt für alle Subshops und alle Zielgruppen. Ob der Inhaber der Adresse den Eintrag bestätigen muss, steuert der Parameter blacklistSelfDoubleOptIn in newsletter.newsletter:

blacklistSelfDoubleOptIn inaktiv: Die Adresse wird sofort auf die Blacklist gesetzt.
blacklistSelfDoubleOptIn aktiv: Der Shop versendet die E-Mail aus newsletter.newsletter → doubleOptInEmailBlacklist mit einem Opt-In-Link an die Adresse. Erst die Bestätigung mit BlacklistAddConfirm setzt die Adresse auf die Blacklist. Im E-Mail-Template erzeugen Sie den Link mit dem Token-Namen confirmBlacklistAdd, siehe $wsOptIn.

In beiden Fällen meldet die Aktion Erfolg, sobald die Eingabe gültig ist. Anwendungsbeispiel
Nutzbar auf einer Seite, auf der Kunden ihre E-Mail-Adresse dauerhaft vom Newsletter-Versand ausschließen können. Parameter

Name	Beschreibung
`email`	Die E-Mail-Adresse, die auf die Blacklist gesetzt werden soll.

Fehlercodes Die Fehlertexte stammen aus actions.newsletterSubscribe.

Fehlercode	Beschreibung
`missingField`	Parameter `email` fehlt oder ist leer.
`emailCheckFailed`	Die angegebene E-Mail-Adresse ist ungültig.

Zugehörige Module, Variablen & Methoden

$wsOptIn

Beispiel das zeigt, wie ein Kunde seine E-Mail-Adresse eingibt, um sie auf die Blacklist setzen zu lassen, inklusive Erfolgsausgabe.

{{ var $myActionBlacklistAdd = $wsActions.create('BlacklistAdd') }}
<form method="post" action="{{= $wsViews.current.url() }}">
    <input type="hidden" name="wscsrf" value="{{= $myActionBlacklistAdd.csrf }}">
    <input type="hidden" name="wsact" value="{{= $myActionBlacklistAdd.id }}">
    {{ if $myActionBlacklistAdd.success }}
        <div class="alert alert-success">Ihre Anfrage wurde gespeichert.</div>
    {{ else }}
        <input type="email" name="email">
        <button type="submit">Vom Newsletter-Versand ausschließen</button>
    {{ /if }}
</form>

BlacklistAddConfirm

Mit dieser Aktion wird der Eintrag einer E-Mail-Adresse in die Blacklist per Double-Opt-In bestätigt. Die Aktion übernimmt die E-Mail-Adresse aus dem Opt-In-Token und setzt sie auf die Blacklist. Anwendungsbeispiel
Nutzbar auf der Bestätigungsseite, auf die der Kunde nach Klick auf den Opt-In-Link in der E-Mail aus BlacklistAdd weitergeleitet wird. Fehlercodes Die Fehlertexte werden in actions.blacklistAdd gepflegt.

Fehlercode	Beschreibung
`actionNotAllowed`	Es wurde kein gültiger Opt-In-Token für diese Aktion übergeben.

Zugehörige Module, Variablen & Methoden

$wsOptIn

Beispiel das zeigt, wie nach erfolgreicher Bestätigung eine Erfolgsmeldung angezeigt wird und bei einem ungültigen Token ein Fehlerhinweis erscheint.

{{ var $myActionBlacklistAddConfirm = $wsActions.create('BlacklistAddConfirm') }}
<form method="post" action="{{= $wsViews.current.url() }}">
    <input type="hidden" name="wscsrf" value="{{= $myActionBlacklistAddConfirm.csrf }}">
    <input type="hidden" name="wsact" value="{{= $myActionBlacklistAddConfirm.id }}">
    {{ if $myActionBlacklistAddConfirm.success }}
        <div class="alert alert-success">Ihre E-Mail-Adresse wurde vom Newsletter-Versand ausgeschlossen.</div>
    {{ else }}
        {{ foreach $myError in $myActionBlacklistAddConfirm.globalErrors }}
            <div class="alert alert-danger">{{= $myError.text }}</div>
        {{ /foreach }}
        <button type="submit">Eintrag bestätigen</button>
    {{ /if }}
</form>

WEBSALE

Frontend

Die Basics

Getting Started

Referenz – Aktionen

Referenz – Sprache

Referenz – Module

Integrationsanleitung

Praxisbeispiele

Aktionen im Überblick

Aktionen

NewsletterSubscribe

NewsletterSubscribeConfirm

NewsletterUnsubscribe

NewsletterUnsubscribeConfirm

BlacklistAdd

BlacklistAddConfirm

​Aktionen im Überblick

​Aktionen

​NewsletterSubscribe

​NewsletterSubscribeConfirm

​NewsletterUnsubscribe

​NewsletterUnsubscribeConfirm

​BlacklistAdd

​BlacklistAddConfirm

Aktionen im Überblick

Aktionen

NewsletterSubscribe

NewsletterSubscribeConfirm

NewsletterUnsubscribe

NewsletterUnsubscribeConfirm

BlacklistAdd

BlacklistAddConfirm