Setup und Konfiguration "direct_mail" und "Newsletter"

Stand: 2023-02-20

Tickets:

Neues Ticket "Sammelticket Änderungsanforderungen"

https://jira.udg.de/browse/ZIRLPV11-95

Alle Screenshots sind von Stage übernommen, somit sind die Seiten-ID's der Screenshots nicht die vom Live-System!

Übersicht Seiten

Struktur Seiten

Frontend-Setup: TypoScript

Neues TypoScript im System.

Hinweis: Es wurde das TypoScript für die Steuerung des Anmeldeformulars auf der Startseite angepasst.

global {
  newsletter {
    # page template footer newsletter subscription form
    page {
      # cat=global.pagenewslettersubscription.footer/enable/t1; type=bool; label=page template footer newsletter newsletterSubscribe
      newsletterSubscribe = 1
      # cat=global.pagenewslettersubscription.footer/links/t2; type=string; label=page template footer newsletter actionUrl
      actionUrl =
      # cat=global.pagenewslettersubscription.footer/file; type=string; label=page template footer newsletter image
      image = EXT:rlp_base/Resources/Public/Images/Newsletter/Neuo_Ausschnitt.jpg
      # cat=global.pagenewslettersubscription.footer/ctext/t3; type=string; label=page template footer newsletter alt
      alt = Newsletter
      # cat=global.pagenewslettersubscription.footer/ctext/t4; type=string; label=page template footer newsletter title
      title = Newsletter
      # cat=global.pagenewslettersubscription.footer/ctext/t5; type=string; label=page template footer newsletter copyright
      copyright = Newsletter
    }

    # page direct_mail folder pid
    mail {
      # cat=global.directMailNewsletterTemplate/links/d1; type=int+; label=Direct Mail Newsletter Root Pid: direct_mail base folder. this pid also must be set in "Page TSconfig"
      folder =
    }

    # newsletter template direct_mail folder settings
    template {
      news {
        # cat=global.directMailNewsletterTemplate/links/e1; type=int+; label=ext-news Detail View Pid: Mandatory pid for "read more" links.
        detailPid =
        # cat=global.directMailNewsletterTemplate/links/e2; type=int+; label=ext-news Detail List Pid: Mandatory pid for "#Themen" links.
        backPid =
        # cat=global.directMailNewsletterTemplate/links/e3; type=int+; label=ext-news Detail Mailing Pid: Mandatory pid for detail news page title provider.
        mailingPid =
      }
      header {
        # cat=global.directMailNewsletterTemplate/file/h1; type=string; label=Direct Mail Newsletter Template Header Logo
        logoUrl = EXT:rlp_base/Resources/Public/Images/Newsletter/Logo/rlp-logo_640px.png
        # cat=global.directMailNewsletterTemplate/ctext/h2; type=string; label=Direct Mail Newsletter Template Header Newsletter Type/Name: Set type/name "Newsletter" or "Pressemitteilungen"
        label = Newsletter
      }
      footer {
        # cat=global.directMailNewsletterTemplate/links/f1; type=int+; label=Direct Mail Newsletter Template Footer Contact Pid
        contactPid =
        # cat=global.directMailNewsletterTemplate/links/f2; type=int+; label=Direct Mail Newsletter Template Footer Imprint Pid
        imprintPid =
        # cat=global.directMailNewsletterTemplate/links/f3; type=int+; label=Direct Mail Newsletter Template Footer Data Protection Pid
        dataprotectionPid =
        # cat=global.directMailNewsletterTemplate/links/f4; type=int+; label=Direct Mail Newsletter Template Footer Unsubscribe URL Pid
        unsubscribePagePid =
      }
    }
  }
}

Neu: TypoScript kann jetzt auch über den Konstanten-Editor gesetzt werden.

Die Unterteilung hier ist wie folgt:

plugin.tx_udg_newsletter: Newsletter An- und Abmeldung
global.pagenewslettersubscription.footer: Das Anmeldeformualr auf der Startseite
global.directmailnewslettertemplate: alle Settings zu direct_mail

Aktuelles TypoScript Setup von "Live - Doku" / https://typo3-doku.t3v11-zi.rlp.de/

Hier das aktuelle Setup vom sys_template aus der pid#1:

# start setup newsletter / mailing / direct_mail
global.news.excludedCategories = 105

global.newsletter {
  page {
    newsletterSubscribe = 1
    actionUrl = 4329
    image = EXT:rlp_base/Resources/Public/Images/Newsletter/Neuo_Ausschnitt.jpg
    alt = Newsletter
    title = Newsletter
    copyright = Newsletter
  }  
  mail {
    folder = 4332
  }
  template {
    news {
      detailPid = 284
      backPid = 280
      mailingPid = 4342
    }
    header {
      logoUrl = EXT:rlp_base/Resources/Public/Images/Newsletter/Logo/rlp-logo_640px.png
      label = Newsletter
    }
    footer {
      contactPid = 235
      imprintPid = 2
      dataprotectionPid = 240
      unsubscribePagePid = 4330
    }
  }  
}
# end setup newsletter / mailing / direct_mail

# start tx_udgnewsletter double opt 
plugin.tx_udgnewsletter {
    settings {
        general {
			storagePid = 4343
			doubleOptPid = 4331
        }
        subscription {
            #subject = Newsletter Anmeldung
            #senderAddress = typo3@rlp.de
            #senderName = rlp.de Newsletter
            redirectPid = 4333
        }
        unsubscription {
            #subject = Newsletter Abmeldung
            #senderAddress = typo3@rlp.de
            #senderName = rlp.de Newsletter
            redirectPid = 4334
        }
        doubleOpt {
            in {
                successPageUid = 4335
                failurePageUid = 4336
            }
            out {
                successPageUid = 4337
                failurePageUid = 4338
            }
            deny {
                successPageUid = 4339
                failurePageUid = 4340
            }
        }
    }
}
# end tx_udgnewsletter double opt

Backend Setup: Page TSconfig

Zusätzlich muss eine Einstellung in "Page TSconfig" gesetzt werden, so dass das Backend auf den Newsletter angepasst wird.

Hierfür gibt es drei Arten der Einbindung:

Auf der Root-Seite mit der pid vom direct_mail-Folder (hier im Beispiel die 615)
Kann auf der Root-Seite hinterlegt werden, die ID spricht dann die Unterseiten an.
Auf der direct_mail-Seite selbst als TS-Eintrag
Vorsicht: Vererbt auf alle Unterseiten, nicht im Root hinzufügen!
Auf der direct_mail-Seite selbst als Static-Include
Vorsicht: Vererbt auf alle Unterseiten, nicht im Root hinzufügen!

Hinweis: Auf Stage waren im Root pid#1 noch alte Einträge vom PageTS die unsere Überschrieben haben. Wir haben diese auf Stage entfernt, da die unseres Wissens nach alle inzwischen im Rahmen von Tickets in die rlp_base deployed worden sind.

PageTSConfig-Code für die Root-Pid:

[4332 in tree.rootLineIds]
    # Backend layouts for newsletter pages
    @import 'EXT:rlp_base/Configuration/TsConfig/Page/DirectMail/All.tsconfig'
[END]

4332 ist hier in diesem Beispiel die pid vom direct_mail folder.

Warum ein Backend-Layout:

Hierdurch werden nur für die Newsletter relevanten Content-Elemente und Eingabefelder für diesen Bereich zugelassen.

Somit wird ein sauberer output des Newsletters garantiert.

PageTS Config ZIRLPV11-4

Analog des alten V8-Systems wird in der PageTS vom News-Folder die Konfiguration hinterlegt.

Der Scheduler prüft pro Domain, ob es eine Konfiguration gibt und ob diese vollständig ist!

Wenn beide Kriterien erfüllt sind, wird er für diese Domain ausgeführt.

Es werden nur News versendet, welche die ausgewählte Kategorie aus dem Scheduler haben, wo das News-Feld "Newsletter sent date[newslettersent]" ohne Eintrag ist (default) und wo das News-Feld "Vom Versand ausschliessen[exclude_from_newsletter]" auf "false" ist (default).

PageTSConfig-Code für die News-Pid:

module.tx_udgnewsletter {
  receiverPid = 4343
  newsletterPid = 4342
  senderName = Demo Mailing Live-Doku
  senderMail = live-doku@typo3-doku.t3v11-z1.rlp.de
}

4343 ist hier in diesem Beispiel die pid vom Empfänger folder,
4342 ist hier in diesem Beispiel die pid vom der Seite mit dem leeren News-Detail-View-Plugin.

direct_mail Setup

direct_mail kann über zwei Arten konfiguriert werden:

Über das Modul "Configuration"
Über PageTSConfig

Bei einem Eintrag im Modul "Configuration" werden diese Settings in das PageTSConfig des direct_mail folders geschrieben.

Hinweis: wir haben hier die Adressaten auf tt_address ausgelegt.

Scheduler-Task

Zum aktuellen Zeitpunkt gibt es drei Tasks:

direct_mail Versand (ZIRLPV11-6)
Newsletter Anmeldung: Unbestätigte Mails älter als sieben Tage löschen (ZIRLPV11-11)
News-Mailer (ZIRLPV11-4)

Direct Mail Newsletter

Für einen Newsletter sind folgende Content-Elemente erlaubt:

Text&Media
"Shortcut". In diesem können dann wiederum News-Records geladen werden.

Die Content-Elemente sind auf die für das Mailing relevanten Eingabefelder reduziert.

Mit "Rahmen[frame_class]" können die Hintergründe auf "weiß" oder "grau" eingestellt werden.

News Mailing

Für ein News-Mailing sind folgende Content-Elemente erlaubt:

News Plugin Detail-View.

Das Plugin wird nicht konfiguriert, es darf darin auch keine Single-News verlinkt sein. Der gewünschte Eintrag kommt vom Mail-Skript.

Im Plugin muss bei "Template-Layout [settings.templateLayout]" der Eintrag "Special news newsletter page [newsNewsletterSpecialPage]" ausgewählt sein.