Skip to content

Latest commit

 

History

History
77 lines (60 loc) · 3.98 KB

README.md

File metadata and controls

77 lines (60 loc) · 3.98 KB
Raw

Magento 2 Module Experius email catcher / - logger

``experius/module-emailcatcher``

Main Functionalities

  • Log all Emails send by Magento
  • View email contecnt in popup (Nice for testing and styling)
  • Forward a catched email
  • Resend a catched email
  • Cleanup of emails older then 30 days (cron or manual)
  • Send emails based on whitelisted email templates

Versions

  • Version 3.0.0 or higher is fully compatible with 2.2.x and 2.3.x

[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
  • 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:
    • private repository repo.magento.com
    • public repository packagist.org
    • public github repository as vcs
  • Add the composer repository to the configuration by running composer config repositories.repo.magento.com composer https://repo.magento.com/
  • 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

Change log

Version 3.1.0 - November 8th, 2019

  • [FEATURE] Created preferences on Magento email classes (Transport / TransportBuilder) to preserve template identifier on email transport. This will allow filtering of email sending (in sendMessage()) based of configurable template whitelist.
  • [FEATURE] Added logic to check email versus whitelisted templates and send those configured to be whitelisted
  • [FEATURE] Added custom email templates to dropdown selector for templates to whitelist
  • [FEATURE] Added logic to check email versus whitelist, where non-whitelisted templates are halted.
  • [BUGFIX] Empty whitelist was still sending email, resolved this by making !empty() check on template whitelist.
  • [REFACTOR] Small refactor for readability of class functions in plugin.
  • [BUGFIX] Message for resending was incorrectly displaying empty email adress. Message rewritten to "email was resent".

Version 3.0.0 - October 9th, 2019

  • [REFACTOR] DocBlocks and module composer require namespace changed
  • [FEATURE] Magento 2.3.3 support for forwarding and resending emails using the newly introduced \Magento\Framework\Mail\EmailMessageInterface. Fully backwards compatible to 2.2.x
  • [DOCS] Updated README, starting change logs