experius / module-emailcatcher
Installs: 249 918
Dependents: 0
Suggesters: 0
Security: 0
Stars: 59
Watchers: 13
Forks: 25
Open Issues: 1
Requires
- php: ^8
- dev-master
- 4.0.1
- 4.0.0
- 3.5.3
- 3.5.2
- 3.5.1
- 3.5.0
- 3.4.4
- 3.4.3
- 3.4.2
- 3.4.1
- 3.4.0
- 3.3.2
- 3.3.1
- 3.3.0
- 3.2.0
- 3.1.4
- 3.1.3
- 3.1.2
- 3.1.1
- 3.1.0
- 3.0.0
- 2.2.6
- 2.2.5
- 2.2.4
- 2.2.3
- 2.2.2
- 2.2.1
- 2.2.0
- 2.1.3
- 2.1.2
- 2.1.1
- 2.1.0
- 2.0.0
- 1.3.10
- 1.3.9
- 1.3.8
- 1.3.7
- 1.3.6
- 1.3.5
- 1.3.4
- 1.3.3
- 1.3.2
- 1.3.1
- 1.3.0
- 1.2.1
- 1.2.0
- 1.1.1
- 1.1.0
- 1.0.6
- 1.0.5
- 1.0.4
- 1.0.3
- 1.0.2
- 1.0.1
- v1.0.0
- dev-feature/SCSUP-1684
- dev-upgrade-fix
- dev-password-reset-fix
- dev-feature/whitelist-specific-templates
- dev-feature/full-2.3.3-support
- dev-magento-2.3.3
- dev-bugfix/PGW-228
- dev-magento-2.3
- dev-magento-2.1
This package is auto-updated.
Last update: 2024-03-22 16:35:36 UTC
README
``experius/module-emailcatcher``
Main Functionalities
- Log all Emails send by Magento
- View email content in popup (Nice for testing and styling)
- Forward a caught email
- Resend a caught email
- Cleanup emails older than 30 days (cron or manual)
- Send emails based on whitelisted email templates
Versions
-
Version 4.x or higher is compatible with Magento >= 2.4.6-p2; PHP >= 8.2
-
Version 3.x is compatible with Magento >= 2.2.0 <= 2.4.5; PHP 7.4 compatible
[Please note that from 3.0.0 onward the composer require changed to experius/module-emailcatcher]
- Version 2.0.0 or higher is compatible with Magento 2.2 or higher
- Version 1.3.2 or higher is compatible with Magento 2.1.8 or higher
- Version lower then 1.3.2 could still be used for Magento 2.1.7 or lower but we recommend to install a newer version
Installation
In production please use the --keep-generated option
Type 1: Zip file
- Unzip the zip file in
app/code/Experius/EmailCatcher - Enable the module by running
php bin/magento module:enable Experius_EmailCatcher - Apply database updates by running
php bin/magento setup:upgrade - Flush the cache by running
php bin/magento cache:flush
Type 2: Composer
- Make the module available in a composer repository for example:
- public repository
packagist.org - public github repository as vcs
- public repository
- Install the module composer by running
composer require experius/module-emailcatcher - Enable the module by running
php bin/magento module:enable Experius_EmailCatcher - Apply database updates by running
php bin/magento setup:upgrade - Flush the cache by running
php bin/magento cache:flush
Enable email catcher
Enable Email Catcher.
- Stores > Settings > Configuration > Advanced > Email Catcher > General > Enable Email Catcher (emailcatcher/general/enabled)
Disable email sending (default Magento, advised for development)
- Stores > Settings > Configuration > Advanced > System > Mail Sending Settings > Disable Email Communications (system/smpt/disable)
Utilise whitelist functionality
- Stores > Settings > Configuration > Advanced > Email Catcher > Whitelist > Apply whitelist (emailcatcher/whitelist/apply_whitelist)
- Stores > Settings > Configuration > Advanced > Email Catcher > Whitelist > Whitelisted templates (emailcatcher/whitelist/email_templates)
Admin grid
- System > Tools > Email Catcher