mfd / typo3-mail-routing

0.1.2 2025-04-17 13:33 UTC

Requires

• php: ^8.1
• typo3/cms-core: >= 13.4.5

Requires (Dev)

• saschaegerer/phpstan-typo3: ^2.1
• ssch/typo3-rector: ^3.1

GPL-3.0-or-later

• Christian Spoo

• mailer
• routing
• transport
• typo3
• e-mail

Published on Packagist.org on 2025-04-17 13:34 UTC

README

A TYPO3 CMS extension that enables flexible e-mail transport routing. This extension allows you to control which mail transport is used for sending emails either globally for your entire site or on a per-email basis.

Features

• Route emails to different transports using the X-Mail-Transport header
• Configure a default transport for a certain site
• Override the default transport on a per-email basis by setting the X-Mail-Transport header
• Seamless integration with TYPO3's mail system
• Support for multiple mail transport configurations
• Easy to extend and customize

Requirements

• PHP 8.2 or higher
• TYPO3 CMS 13.4.5 or higher, including 14.x

Installation

1. Install via Composer:

composer require mfd/typo3-mail-routing

1. Include the extension in your TYPO3 installation:
   • Activate the extension in the TYPO3 Extension Manager
   • Or include it in your composer.json and run composer update

Configuration

The extension is configured through EXTCONF settings that follow the same conventions as TYPO3's mail configuration ($GLOBALS['TYPO3_CONF_VARS']['MAIL']). You can configure these settings in your config/system/additional.php file:

$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['mail_routing'] = [
    'transports' => [
        'special_smtp' => [
            'transport' => 'smtp',
            'host' => 'smtp.example.org',
            'port' => 25,
            // ... other SMTP settings
        ],
        'sendmail' => [
            'transport' => 'sendmail',
            'command' => '/usr/sbin/sendmail -bs',
        ],
    ]
    // Add more transport configurations as needed
];

Each transport configuration should match the structure expected by TYPO3's mail system. The name default is reserved and always uses the regular $GLOBALS['TYPO3_CONF_VARS']['MAIL'] transport, as do unknown names.

Select a transport per e-mail with the X-Mail-Transport header (removed before sending), or per site with the site setting mailer in config/sites/<site>/settings.yaml.

Development

Setup Development Environment

1. Clone the repository
2. Install dependencies:

composer install

Code Quality Tools

The extension includes several code quality tools:

• PHPStan for static analysis
• PHPCS for code style checking
• Rector for automated refactoring

Run PHPStan analysis:

composer phpstan

License

This extension is licensed under GPL-3.0-or-later.

Author

• Christian Spoo ([e-mail])

Support

For support, please create an issue in the GitHub repository or contact the author directly.