Introduction
The module transfers the data of newsletter subscribers from Typo3 to Maileon. Since version 2.5.0, no contact data is stored in Typo3, which makes it easier to set up, as the flow of information from Maileon to Typo3 (DOI confirmers and unsubscribers) is no longer required.
All parameters of the transmission can be set via variables in Typo3.
...
Installation
Install with Composer
The extension can also be installed with Composer as a local package.
The extension package should be placed in a dedicated, local directory: documentroot/packages.
Once this directory exists, update the installations composer.json and add this directory as a new repository:
| Code Block | ||
|---|---|---|
| ||
{
"repositories": [
{
"type": "path",
"url": "packages/*"
},
],
} |
Then run composer require to the install the local extension typo3-maileon-integration with vendor xqueue:
...
| Table of Contents | ||
|---|---|---|
|
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.
...
Installation
Install via Composer
The extension can be installed using Composer with the following command:
| Code Block |
|---|
composer req xqueue/typo3-maileon-integration:@dev |
By executing this command, Composer locates xqueue/typo3-maileon-integration and then symlinks it to typo3conf/ext/typo3-maileon-integration
Install with Zip package
...
Get the Zip package:
...
https://extensions.typo3.org/extension/typo3_maileon_integration
...
After installation, run the setup command to finalize the configuration:
| Code Block |
|---|
php vendor/bin/typo3 extension:setup |
Install via ZIP package
Alternatively, the extension can be installed manually using a ZIP package:
Download the ZIP package from the TYPO3 Extension Repository: TYPO3 Maileon Integration Extension
Log in to the TYPO3 backend.
...
Navigate to Admin Tools → Extensions.
Upload the downloaded ZIP package
...
Install with Zip package
...
to install the extension.
Inserting TypoScript
To insert a TypoScript for the plugin, first select "List" in the menu on the left. Then select the page root follow these steps:
In the TYPO3 backend, navigate to the “List” module in the left-hand menu.
Select the root page element in the page administration.
...
Edit the
...
existing TypoScript record.
...
Select the Advanced Options tab at the top. In the next step, the value "Configuration for Typo 3 - Maileon integration Next, open the “Advanced Options” tab and locate the “Includes” section. Add “Configuration for TYPO3 - Maileon Integration (typo3_maileon_integration)" is added ” to the list of selected objects under the item "Includes". Then click to Save, then click “Save” to apply the changes.
...
Plugin configuration
After logging Once you have logged into the backend, the configuration can will be found available in the constants of the template.
The easiest most convenient way to adjust modify the configuration is via the TypoScript Object Browser:
...
The following settings can be made here:
...
.
...
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:
Field | Description | Options (0 = No, 1 = Yes) |
|---|---|---|
firstname | Standard field in Maileon |
|
lastname | Standard field in Maileon |
|
organization | Standard field in Maileon |
|
position | Custom field in Maileon |
|
salutation | Standard field in Maileon |
|
subscriptionnumber | Custom field in Maileon |
|
...
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 registration registered plugin must now be displayed placed on the page where the registration form is to be displayedsubscription form should appear. To do this, click on the button for adding new content elementsnavigate to the desired page and click “Add New Content Element” to insert the plugin.
...
In the dialogue dialog that now opensappears, navigate to the type "General Plugin" must be selected under "Plugins".
...
“Plugins” section and select “General Plugin” as the content type.
...
The content block can then be edited and under "Plugin" it can be selected whether it is a login or logout form. After selecting 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 specify which pages are to be forwarded to in the event of a success or errordefine 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 set the define a DOI key on a at the page level, which is used when registering a contact. This makes it possible to link allows different forms with to be linked to different DOI mailings. A The DOI key is set configured as a TypoScript constant set:
plugin.tx_typo3maileonintegration.settings.doiMailingKey = ...
This is possible on setting can be applied to any page within the TYPO3 page tree and is will be inherited by all sub-pages, provided it is not overwritten there., unless explicitly overridden.
To configure this, follow these steps:
Navigate to Site Management → TypoScript.
Select the page where the subscription form is located (e.g., Simple Page).
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.