xima / xima-typo3-mailcatcher
Display mails that were send to log file
Package info
github.com/xima-media/xima-typo3-mailcatcher
Type:typo3-cms-extension
pkg:composer/xima/xima-typo3-mailcatcher
Requires
- php: ^8.1
- ext-json: *
- typo3/cms-backend: ^12.4 || ^13.4 || ^14.3
- typo3/cms-core: ^12.4 || ^13.4 || ^14.3
- typo3/cms-extbase: ^12.4 || ^13.4 || ^14.3
- typo3/cms-fluid: ^12.4 || ^13.4 || ^14.3
- zbateson/mail-mime-parser: ^2.0 || ^3.0
Requires (Dev)
- armin/editorconfig-cli: ^1.8 || ^2.2
- ergebnis/composer-normalize: ^2.54
- friendsofphp/php-cs-fixer: ^3.57
- helhum/typo3-console: ^8.1 || ^9.0
- move-elevator/composer-translation-validator: ^1.4
- phpstan/extension-installer: ^1.3
- phpstan/phpstan: ^1.12 || ^2.0
- saschaegerer/phpstan-typo3: ^1.8 || ^2.0 || ^3.0
- ssch/typo3-rector: ^2.15 || ^3.0
- symfony/translation: ^6.4 || ^7.2
- typo3/cms-install: ^12.4 || ^13.4 || ^14.3
- typo3/testing-framework: ^8.2 || ^9.0
Suggests
None
Provides
None
Conflicts
None
Replaces
None
- dev-main
- v10.x-dev
- 2.0.0
- 1.6.1
- 1.6.0
- 1.5.0
- 1.4.1
- 1.4.0
- v1.3.3
- v1.3.2
- v1.3.1
- v1.3.0
- v1.2.0
- v1.1.0
- v1.0.0
- dev-chore/release-2.0.0
- dev-docs/readme-v14-screenshot
- dev-chore/update-stack
- dev-chore/update-stack-bot-findings
- dev-chore/update-stack-merge-main
- dev-chore/update-stack-followups
- dev-fix/mbox-split-header-order
- dev-docs/security-policy
- dev-remove-bcc
- dev-german-translation
- dev-drop-v10
- dev-css-file
- dev-v13-adjustments
- dev-attachment-tests
- dev-single-format
- dev-fix-v13-tests
- dev-module-access
- dev-release-workflow
- dev-php-errors
- dev-unit-tests
- dev-improve-readme
- dev-fix-decoding
- dev-fix-permissions
- dev-hide-module
- dev-patch-1
- dev-fix-v10-autoloading
- dev-avoid-ext-registration
- dev-remove-ext-conf
- dev-feature/mail-mime-parser
- dev-cc-bcc-fields
- dev-load-html
- dev-embedded-images
This package is auto-updated.
Last update: 2026-11-13 06:08:10 UTC
README
TYPO3 extension xima_typo3_mailcatcher
A TYPO3 extension that adds a backend module to view emails that were sent to
file. With the mbox mail transport, TYPO3 writes outgoing emails to a log file
instead of sending them. This extension reads that file and shows the emails in
the backend, which is handy on development and staging systems.
Features
- Backend module System → Mail Log, available as soon as the
mboxtransport is active - List of all caught emails, newest first, with sender, subject and an attachment indicator
- Detail view with recipient, Cc and date
- Switch between the plain text and the HTML version; HTML is rendered in an
iframe, inline (
cid:) images are resolved - Download attachments
- Delete single emails or all at once
Requirements
- TYPO3 12.4, 13.4 or 14.3
- PHP 8.1+
Installation
composer require xima/xima-typo3-mailcatcher
Or download the extension from the TYPO3 Extension Repository (TER).
Configuration
No extension configuration needed!
Change the mail transport to mbox (see the official
TYPO3 Mail API),
e.g. in config/system/additional.php. TYPO3 then writes outgoing emails to
the file set in transport_mbox_file. The path must be absolute.
$GLOBALS['TYPO3_CONF_VARS']['MAIL']['transport'] = 'mbox'; $GLOBALS['TYPO3_CONF_VARS']['MAIL']['transport_mbox_file'] = \TYPO3\CMS\Core\Core\Environment::getVarPath() . '/log/mail.log';
When the module is opened, it moves the emails from the log file to
public/typo3temp/assets/xima_typo3_mailcatcher/: one JSON file per email
(addresses, subject and full body) plus its attachments. Anyone who can reach
this directory over HTTP can read them.
Development
The repository ships a DDEV setup. ddev init-typo3 sets up
a TYPO3 instance with the mbox transport (backend login admin / Passw0rd!):
ddev start ddev composer install ddev init-typo3
Run the checks and tests:
ddev composer ci:sca
ddev composer test:unit
ddev composer test:functional
ddev playwright test
License
This project is licensed under GNU General Public License 2.0 (or later).
