Preview any transactional email in your Magento 2 backend
Go to your Magento 2 backend, open up the EmailTester page and you are set. You can quickly select any transactional email and preview the email in your browser or send it to a specific inbox.
Most transactional emails in Magento require some kind of data: Customer details, product pricing, a valid quote. EmailTester makes it extremely use to pick a mail and fill it with the dummy data that you want to test.
This extension is also listed on the Magento Marketplace: https://marketplace.magento.com/yireo-magento2-emailtester2.html
With EmailTester, you can select a Magento transactional email and preview it in the browser or send it to an emailaddress of your choice. The preview window allows you to refresh the page, while you work on improving the email layout in your editor.
Sending the email allows you to easily double-check whether the mail is displayed properly across multiple email clients.
From within the form where you select the email to work with, you can also select a customer, a product and an order. From these data, EmailTester is able to derive all email variables needed to display an email with actual content. Inserting different customers or products is easily done. You never need to create a complete test-order again in the frontend to test email behavior.
Our EmailTester picks up on any email that is built using the Magento transactional email system. Simply put, if you can override it in the Magento backend, you can test it with EmailTester.
Additionally, you create your own module to insert additional data into the EmailTester system, for instance if a third party extension adds a new entity to emails. We've made this really easy for developers to adopt: Just use the core event email_order_set_template_vars_before which is meant for this thing.
We recommend to install Magento 2 extensions via composer. See the Composer project for instructions on how to get composer up and running. Once composer is installed, use the following commands to install our extension. Make sure to add in your own subscription key.
composer config repositories.yireo-emailtester2 composer https://api.yireo.com/composer.php/key,YOUR-LICENSE-KEY/
composer require yireo/magento2-emailtester2This will make composer download the package from our online composer repository, using your subscription key for authentication. After the composer installation has finished, use the following commands to enable the module within Magento:
bin/magento module:enable Yireo_EmailTester2
bin/magento cache:clean
bin/magento setup:upgradeAfter these commands, the extension is ready for use in Magento. If you were already logged into the Magento Admin Panel, make sure to logout and log back in again, before proceeding. Do not forget to grab yourself a manual copy of our extension as a backup.
We recommend to install Magento 2 extensions via composer. See the Composer project for instructions on how to get composer up and running. Once composer is installed, download the composer ZIP packages from this webpage under the File Downloads tab. Create a new folder packages within your Magento source and copy the ZIP packages to this new folder. Next, run the following commands (and make sure to include the right path to your Magento source):
composer config repositories.zip-packages artifact /path/to/magento/packages
composer require yireo/magento2-emailtester2Composer will search the packages folder for the latest available package. After the composer installation has finished successfully, use the following commands to enable the module within Magento:
bin/magento module:enable Yireo_EmailTester2
bin/magento cache:clean
bin/magento setup:upgradeAfter these commands, the extension is ready for use in Magento. If you were already logged into the Magento Admin Panel, make sure to logout and log back in again, before proceeding. Do not forget to grab yourself a manual copy of our extension as a backup.
Please note that we highly recommend using composer instead. However, in some cases, it might be required to do a non-composer installation. For this, download the module ZIP from our site (under the tab File Downloads). Next, create a folder with the following name and copy to the ZIP contents to it:
app/code/Yireo/EmailTester2After the files have been uploaded, confirm that all files are in place. For instance, you should have a file like app/code/Yireo/EmailTester2/etc/module.xml. Next, use the following commands to enable the module within Magento:
bin/magento module:enable Yireo_EmailTester2
bin/magento cache:clean
bin/magento setup:upgradeAfter these commands, the extension is ready for use in Magento. If you were already logged into the Magento Admin Panel, make sure to logout and log back in again, before proceeding. Do not forget to grab yourself a manual copy of our extension as a backup.
Login to see the packages available to you
| Name | Package Type | Version | Download link | |
|---|---|---|---|---|
| Download | No access |
No, it is not. As a policy, all our Yireo software is unencrypted - we do not make use of technologies like ionCube or ZendOptimizer. All PHP-code is open source, but for commercial extensions the code is only given to paying customers.
You probably would like to know if this extension is working under a specific Magento version 2.X.Y. However, from a technical point of view, the question is wrong: The major Magento version 2.X.Y is not semantical but instead used for marketing purposes. It doesn't give any guarantees.
Instead, we maintain compatibility with the actual modules that lie underneath (like Magento_Catalog or the Magento Framework). And version management for these dependencies is handled via composer. We strongly advice you to rely on composer to answer the question whether our extension works under a specific Magento version. This is the only way to guarantee compatibility in a professional way.
Alternatively, study our CHANGELOG for details on the progress we made.
Once the subscription expires, the composer feed will not give you any access to the software anymore. We recommend you to download the latest ZIP file from our site and add this to your own private composer repository instead (BitBucket, GitHub) so you keep the latest sources available through composer.
Once you purchase this extension, you get access to the downloads for a period of time (normally 12 months). The downloads folder will contain both minor updates and major updates. You can always download the latest version of the extension at any time by logging into your Yireo Account - as long as you have a support subscription that did not expire yet. Likewise, for the period of the subscription, you can use composer to install the package from the command-line. If your subscription expired, you are required to purchase a new subscription to access new updates.
If you run into problems, we are happy to help you out with the following resources:
We usually respond within 24 hours.
EmailTester is written following standards like PSR-2, MEQP2, ECG and ExtDN.
You can hook into the core event email_order_set_template_vars_before or the custom event emailtester_variables. The second event allows you to inject more dummy content into your test emails.
We have shipped some Integration Tests with this extension, one of which is trying to preview any transactional email found by the extension. This might be slow. We don't care.
Also, this should allow you to determine whether EmailTester works together with transactional emails supplied by a third party extension. Let us know your feedback if you bump into issues here.
This extension ships with PHPUnit tests. The generic PHPUnit configuration in Magento 2 will pick up on these tests. To only test Yireo extensions, you can also run the following:
./vendor/bin/phpunit -c ./vendor/yireo/magento2-emailtester2/phpunit.xml.yireo
See the Magento document for the full procedure.
2.2 (2.2.0, 2.2.1, 2.2.2, 2.2.3, 2.2.4, 2.2.5, 2.2.6, 2.2.7, 2.2.8, 2.2.9)2.3 (2.3.0, 2.3.1, 2.3.2)magento/framework: ^101.0.1|^101.1|^102.0magento/module-backend: ^100.0|^101.0magento/module-catalog: ^101.0|^102.0|^103.0magento/module-checkout: ^100.0magento/module-config: ^100.0|^101.0magento/module-customer: ^100.0|^101.0|^102.0magento/module-eav: ^100.0|^101.0|^102.0magento/module-email: ^100.0|^101.0magento/module-payment: ^100.0magento/module-quote: ^100.0|^101.0magento/module-sales: ^100.0|^101.0|^102.0magento/module-store: ^100.0|^101.0magento/module-ui: ^101.0php: >=7.0.0|<7.3ext-pcre: *All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
etc/config.xmlcheckout_payment_failed_template emailemail_order_set_template_vars_before and emailtester_variables
ExtDN forms a network of Magento extension developers, that strive for a better extension quality - both on a technical level and from an end-users point of view. With industry leaders like Fooman and aHeadworks, ExtDN lifts up the Magento extension space to a new level. And Yireo is proud to be part of this.
