Typo3 Form version (v4.0+)

Typo3 Form version (v4.0+)

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.

  • 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.

Screenshot 2025-02-11 at 14.39.12.png

Installation

Install via Composer

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

composer req xqueue/typo3-maileon-integration

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

php vendor/bin/typo3 extension:setup

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.

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.

Configuration

 

  1. Navigate to Admin ToolsSettingsExtension Configuration

  2. Locate TYPO3 Maileon Integration

  3. Set the following:

    • API Key: Your Maileon API key

Screenshot 2025-06-20 at 15.43.39.png
Extension Configuration
Screenshot 2025-06-20 at 15.44.11.png
Maileon extension config

Usage

 

1. Create a Form

  • Use the built-in Form Editor in TYPO3 to create either a subscription or unsubscription form.

  • A subscription form template is included with the extension, which can be used as a starting point and customized as needed.

  • Add the desired fields to the form.

Screenshot 2025-06-23 at 10.28.33.png
Duplicate the default subscribe form template
Screenshot 2025-06-23 at 10.29.11.png
Form wizard step one
Screenshot 2025-06-23 at 10.29.26.png
Form wizard step two
Screenshot 2025-06-23 at 10.29.51.png
The form duplicated

 

2. Map Fields to Maileon

  • In each field’s settings, add a property named Maileon field name and set its value to the corresponding Maileon field name.

  • The mappings are shown in a table below.

Screenshot 2025-06-23 at 10.30.11.png
Email address edit page

 

3. Add Maileon Finisher

  • At the end of the form, add the MaileonSubscribeFinisher or MaileonUnsubscribeFinisher

  • Configure the finisher with:

    • Initial permission (none, single opt-in, confirmed opt-in, double opt-in, double opt-in plus)

    • Enable DOI process

    • Final permission after DOI process (only if DOI process enabled)

    • Set DOI key (if required, only if DOI process enabled)

Screenshot 2025-12-19 at 11.57.04.png
Subscribe finisher

 

Screenshot 2025-06-23 at 10.46.10.png
Unsubscribe finisher

 

4. Embed Form

  • Save and include the form on any TYPO3 page using a form content element.

Screenshot 2025-06-23 at 10.31.17.png
Add new content to a page
Screenshot 2025-06-23 at 10.31.30.png
Form elements → Form
Screenshot 2025-06-23 at 10.32.03.png
New page content edit
Screenshot 2025-06-23 at 10.32.31.png
Set the form at Plugin options
Screenshot 2025-06-23 at 10.33.10.png
Form at the frontend

Field mapping

Supported Form Input Types

For subscribe or unsubscribe forms, an email address input field is mandatory.

The extension will not process or submit the form data to Maileon unless a valid email address is provided.

Currently, the extension supports the following TYPO3 form input types:

Input type

Data type at Maileon

Input type

Data type at Maileon

Text

string

Textarea

string

Email

string

Checkbox

boolean

Date

date

Number

integer

Telephone

string

URL

string

SingleSelect

string

Hidden

string

Standard Fields

If you want to use Maileon’s standard fields, you can refer to the fields listed in the table below:

Maileon field name at Form field edit

Datatype

Value

Maileon field name at Form field edit

Datatype

Value

address

string

 

birthday

date

Allowed patterns: yyyy-MM-dd and yyyy-MM-dd HH:mm:ss

city

string

 

country

string

 

firstname

string

 

gender

string

Allowed values: m (male), f (female), or d (divers)

hnr

string

 

lastname

string

 

fullname

string

 

locale

string

The value must follow the pattern: xx (example: en) or xx_XX (example: de_DE). „xx“ is the two character language code (ISO 639) and „XX“ the two character code for the country of the language (ISO 3166). Example: british english is notated as „en_GB“ and american english as „en_US“. For just marking a contact as english speaking „en“ is usually enough.

nameday

date

Allowed patterns: yyyy-MM-dd and yyyy-MM-dd HH:mm:ss

organization

string

 

region

string

 

state

string

 

salutation

string

 

title

string

 

zip

string

 

Custom Fields

Any field not listed in the standard fields table will be treated as a custom contact field. These fields are automatically created in Maileon before the first submission if they don’t already exist.

Naming Rules for Custom Fields:

  • Must be in lowercase letters

  • Cannot contain accented letters or special characters

  • Spaces are not allowed – use underscores (_) instead

Make sure your field names follow these rules to avoid issues with field creation in Maileon. For example: phone_number

Checkbox Label with Link

If you want to insert a link into the label text of a checkbox (e.g., for a privacy policy or terms and conditions), the checkbox element settings panel has been extended to support this functionality.

In the Label Link section, you can select the TYPO3 page where the link should navigate. In the Label field, enter the full label text. To define which part of the label should be hyperlinked, wrap that text in square brackets ([ ]).

Screenshot 2025-06-23 at 10.30.29.png