Search by

xima / xima-typo3-mailcatcher

ximamediam.schneider

Display mails that were send to log file

Package info

github.com/xima-media/xima-typo3-mailcatcher

Homepage

Type:typo3-cms-extension

pkg:composer/xima/xima-typo3-mailcatcher

Statistics

Installs: 31 917

Dependents: 0

Suggesters: 0

Stars: 3

Open Issues: 1

2.0.0 2026-11-13 06:07 UTC

README

Extension icon

TYPO3 extension xima_typo3_mailcatcher

Latest version Supported TYPO3 versions Total downloads Tests codecov Composer

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.

Backend module "Mail Log" on TYPO3 v14

Features

  • Backend module System → Mail Log, available as soon as the mbox transport 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).