datamints_mailerapi

Datenblätter Mailerapi Dev Doc Doc

Der datamints_mailerapi sendet das html einer Backend-Seite über HTTP an einen angegebenen Mailserver. Diese kurze Dokumentation hilft Ihnen, die Funktionalität der Erweiterung zu erweitern.

Steckverbinder und Service-Steckverbinder

Die Connectors stellen die Schnittstelle dar, die die Funktionen bestimmt, die ein bestimmter ServiceConnector benötigt um richtig zu funktionieren.

Da fast jede RESTful API, die von einem Maildienst bereitgestellt wird, nach dem gleichen Muster arbeitet, wird eine Factory verwendet, um die benötigte Funktionalität zurückzugeben.

Beispiel und Boilerplate:

/**
 * Der YourServiceConnector implementiert den Transfer zwischen TYPO3 und YourService.
 *
 * @package Datamints\DatamintsMailerapi\Connectors
 */
klasse YourServiceConnector implementiert ConnectorInterface Schnittstelle
{
    /**
     * Der Extbase Objektmanager
     *
     * @var \TYPO3\CMS\Extbase\Object\Object\ObjectManagerInterfaceInterface
     * @inject
     */
    geschützter $objectManager;

    /**
     * Enthält die TypoScript-Einstellungen des Dienstes (settings.service.settings)
     *
     * @var-Array
     */
    geschützte $settings;

    /**
     * KajomiConnector Konstruktor.
     * $settings repräsentiert die TypoScript-Einstellungen des Dienstes.
     * werkseitig werden diese Einstellungen über den ObjectManager an den Konnektor übergeben.
     *
     * @param array $Einstellungen
     */
    öffentliche Funktion __construct($settings)
    {
        $this->settings = $settings;
    }

    /**
     * @inheritdoc
     */
    öffentliche Funktion sendHtml($mailingId, $html)
    {
     / / / Spezifische Logik geht hierhin
    }

    /**
     * @inheritdoc
     */
    öffentliche Funktion getMailings()
    {
        / / / Spezifische Logik geht hierhin
    }

TypoScript

Um einen neuen Connector hinzuzufügen, sind 2 Schritte erforderlich. Hinzufügen eines ServiceConnectors zu den Klassen/Konnektoren und Erweiterung des TypoScript.

eine mögliche TypoScript-Konfiguration kann so aussehen:

    module.tx_datamintsmailerapi {
        ## Vorlagen, Layouts, Teiltöne.....

        einstellungen {
            yourservice {
                label = Der beste E-Mail-Service der Welt!
                id = yourservice
                class = Namensraum\Of\The\Specific\ServiceConnector\YourServiceConnector\YourServiceConnector
                backend = http://address/to/your/service/backend/

                einstellungen {
                    ## die spezifischen Einstellungen Ihres Dienstes finden Sie hier !
                    ## z.B. die Konfiguration, die zur Authentifizierung benötigt wird
                    ## oder einfach nur etw., das von Ihrem Dienst benötigt wird, um zu funktionieren.
                }
            }
        }
    }

Erklärung:

• etikett: Das Label, das im Dropdown-Menü angezeigt wird.

• id: die id deines dienstes. stelle sicher, dass sie genau die gleiche ist wie settings.yourservice !!!!!!

• klasse: der Namensraum des Serviceconnectors

• backend: die URL zum Backend des Mail-Service-Providers.

• einstellungen: Hier gehen Sie zu den Dienstanbieter-spezifischen Einstellungen.

mailings abrufen

Das Wichtigste zuerst. Wenn Sie eine neue API zur Erweiterung hinzufügen, müssen Sie alle "Mailings" abrufen, die geeignet sind, von der Erweiterung geändert zu werden.

Beachten Sie, dass der Begriff "Mailing" nicht als "Mailing" bezeichnet werden muss, sondern nur die unfertige, nicht gesendete Ziehung eines Newsletters oder einer Mail im entsprechenden Backend durch den Maildienst.

Die

getMailings()

funktion muss immer ein Mailing[] Modell zurückgeben, das die notwendigen Informationen enthält.

Eine Mailing[] sieht so aus:

[
    0 => [
        id => 'id', // der Bezeichner der Ressource, die Sie ändern möchten
        name => 'name', // der Name der Ressource, die Sie ändern möchten, z.B. der Betreff.
    ]
]

hTML an die API senden

Das HTML einer Seite wird an die jeweilige Ressource gesendet (schamloses Mailing genannt). Beim Hinzufügen eines ServiceConnectors (durch Hinzufügen der Klasse und des Typoskripts) und Sie haben alles richtig gemacht,

authentifizierung

Die Authentifizierung ist oft sehr spezifisch. In diesem Fall wird die Schnittstelle Sie nicht einschränken. Du kannst gerne deine eigene Authentifizierungsmethode hinzufügen, wenn du sie brauchst.