sgalinski/sg-campaigns

Newsletter Campaigns - TYPO3 newsletter extension with double opt-in subscriptions, subscriber groups, scheduled campaigns, FAL attachments, frontend archive and sg_mail queue delivery.

1.2.0 2026-08-14 23:43 UTC

Requires

• php: >=8.3
• altcha-org/altcha: ^1.0
• sgalinski/sg-mail: ^11.0
• typo3/cms-core: >=14.3.0 <=14.3.99

GPL-2.0-or-later

Published on Packagist.org on 2026-08-14 23:46 UTC

README

License: GNU GPL, Version 2

Repository: https://gitlab.sgalinski.de/typo3/sg_campaigns

Please report bugs here: https://gitlab.sgalinski.de/typo3/sg_campaigns/-/issues

Overview

sg_campaigns provides newsletter campaigns for TYPO3. It manages subscriber groups and double opt-in subscriptions, creates scheduled newsletter dispatches, and delivers messages through sg_mail.

The extension also provides frontend content elements for embedded newsletter subscriptions, subscription management, and an optional archive of sent campaigns.

Requirements

• TYPO3 14.3
• PHP 8.3 or newer
• sg_mail 11 or newer
• TYPO3 system extension form when using generated subscription forms

Installation

composer require sgalinski/sg-campaigns

After installation, activate the extension and run the TYPO3 Database Analyzer. Configure sg_mail before creating the first campaign.

Configuration

Set managePageUid in Settings > Extension Configuration > sg_campaigns to the page containing the Newsletter Subscription Management content element. This page is used in newsletter footer links.

Create at least one subscriber group in Web > Newsletter. Each group defines its language and double-opt-in behaviour.

Configure a recurring TYPO3 Scheduler task for the command below. The scheduler itself must be triggered by a system cron job in production.

vendor/bin/typo3 sg_campaigns:processNewsletterQueue 25

The backend module includes a sgalinski product announcement. It is selected from Configuration/Backend/Advertisements.php and can be dismissed for the current backend session.

Optional bounce maintenance commands:

vendor/bin/typo3 sg_campaigns:cleanupBouncedSubscribers --dry-run
vendor/bin/typo3 sg_campaigns:processBounceMailbox --dry-run

Enable Altcha in the subscription content element only when the site can load the Altcha web component from the configured CDN and the TYPO3 encryption key is set.

Usage

Backend campaigns

Use Web > Newsletter to manage subscribers and subscriber groups, compose a campaign, select recipients, and send it immediately or schedule it. The history view shows pending, processed, sent, and failed dispatches.

The advanced visual editor and its styles are loaded only after selecting Advanced editor. The simple editor therefore does not download the large visual-editor bundle.

Attachments are imported into FAL and linked to the campaign dispatch. Archive entries can expose these files as downloads when the selected FAL storage is public. Do not upload confidential files to a publicly accessible storage.

Subscription forms

Create a form in the TYPO3 Form Editor and add the CampaignSubscribe finisher, or use Generate Subscription Form in the subscriber-group view. Configure the target subscriber group in the finisher options.

Use the Newsletter Subscription Form content element to embed a signup form directly on a page. Use the Newsletter Subscription Management content element on the page configured through managePageUid.

Newsletter archive

Use the Newsletter List content element to show sent campaigns. It renders the stored campaign snapshot, so later changes to a draft do not alter archived newsletters.

Examples

Importable editor and CSV examples are available in Documentation/Examples.

Testing

Run the extension checks from the project root:

composer ecs vendor/sgalinski/sg-campaigns
composer phpstan vendor/sgalinski/sg-campaigns
composer phpunit vendor/sgalinski/sg-campaigns