Typo3 (v12+ LTS)

Introduction

The Typo3MaileonIntegration TYPO3 extension enables seamless integration between TYPO3 and Maileon, a powerful email marketing platform. With this extension, website administrators can effortlessly synchronize newsletter subscribers from TYPO3 to Maileon, ensuring that their email lists remain up to date without manual intervention.

This extension is designed for TYPO3 users who want to leverage Maileon’s advanced email marketing and automation features while managing their subscriber data directly within their TYPO3 website. Whether you’re running a small business newsletter or managing large-scale email campaigns, this extension helps streamline the process of collecting, organizing, and exporting subscriber data to Maileon.

Key Features:

• Automatic Synchronization – Send new subscribers from TYPO3 to Maileon in real-time.

• Custom Field Mapping – Map TYPO3 subscriber fields to Maileon fields to ensure consistent data transfer.

• Flexible Subscription Handling – Support for opt-in confirmations and GDPR-compliant data processing.

With this extension, you can focus on building engaging email campaigns while keeping your subscriber lists automatically synchronized.

Open

Installation

Install via Composer

The extension can be installed using Composer with the following command:

After installation, run the setup command to finalize the configuration:

Install via ZIP package

Alternatively, the extension can be installed manually using a ZIP package:

1. Download the ZIP package from the TYPO3 Extension Repository: TYPO3 Maileon Integration Extension

2. Log in to the TYPO3 backend.

3. Navigate to Admin Tools → Extensions.

4. Upload the downloaded ZIP package to install the extension.

Inserting TypoScript

To insert TypoScript for the plugin, follow these steps:

1. In the TYPO3 backend, navigate to the “List” module in the left-hand menu.

2. Select the root page element in the page administration.

3. Edit the existing TypoScript record.

Open

Next, open the “Advanced Options” tab and locate the “Includes” section. Add “Configuration for TYPO3 - Maileon Integration (typo3_maileon_integration)” to the list of selected objects, then click “Save” to apply the changes.

Plugin configuration

Once you have logged into the backend, the configuration will be available in the constants of the template.
The most convenient way to modify the configuration is via the TypoScript Object Browser.

This section outlines the configuration options for the TYPO3 - Maileon integration.

General Settings

• apiKey (Required): Your Maileon API key.

• debug: Enable debug output (0 = Off, 1 = On).

• doiMailingKey: Specify a DOI mailing key if a custom DOI email should be used instead of the default Maileon mailing. This can be overridden at the form level.

• privacyPolicyUrl: Define the URL for the privacy notice link in the subscription form.

• targetPermission: Defines the permission level after clicking the DOI link. Options:

  • 4 = DOI (Double Opt-In)

  • 5 = DOI+ (DOI with single-user tracking permission)

Subscription Form Configuration

The subscription form supports both standard and custom fields, allowing for flexible data collection.

Standard Fields

These fields correspond to predefined fields in Maileon. Each field can be enabled, required, or hidden:

Custom Fields

Up to 5 custom fields can be added. If a custom field does not already exist in Maileon, it will be created automatically.

Each custom field has the following configurable options:

• active: Enable or disable the field in the subscription form (0 = Disable, 1 = Enable).

• dataType: Specify the data type (string, boolean).

• inputType: Define the input type (text, email, checkbox, hidden, textarea).

• label: Set the field label in the form.

• name: Define the field name as it will appear in Maileon (must use underscores instead of spaces). eg.: custom_field_1

• required: Mark the field as mandatory (0 = No, 1 = Yes).

• value: Assign a predefined value (used mainly for hidden fields).

After every config change, the cache should be cleared. You can do this here:

Insert newsletter subscribe form

The registered plugin must now be placed on the page where the subscription form should appear. To do this, navigate to the desired page and click “Add New Content Element” to insert the plugin.

In the dialog that appears, navigate to the “Plugins” section and select “General Plugin” as the content type.

The content block can now be edited. Under the “Plugin” section, select whether the form should function as a subscribe or unsubscribe form. After choosing the type, you can also define the redirect pages for successful and error scenarios.

The subscribe form

The subscription form can be adapted in the html form file:

typo3_maileon_integration/Resources/Private/Templates/Subscribe/Subscribe.html

Forms with different DOI mailings

Since version 2.1.0, it is possible to define a DOI key at the page level, which is used when registering a contact. This allows different forms to be linked to different DOI mailings. The DOI key is configured as a TypoScript constant:

plugin.tx_typo3maileonintegration.settings.doiMailingKey = ...

This setting can be applied to any page within the TYPO3 page tree and will be inherited by all sub-pages, unless explicitly overridden.

To configure this, follow these steps:

1. Navigate to Site Management → TypoScript.

2. Select the page where the subscription form is located (e.g., Simple Page).

3. Proceed with the following configuration steps.

The subscribe/unsubscribe form CSS

The extension uses the Bootsrap CSS classes by default. To make it work you need the Bootstrap Package extension. But the forms can also be used with any other CSS.

https://extensions.typo3.org/extension/bootstrap_package