https://github.com/ubermanu/magento2-email
✉️ Command line tool to send Magento 2 email templates
https://github.com/ubermanu/magento2-email
cli email magento2 testing
Last synced: about 1 year ago
JSON representation
✉️ Command line tool to send Magento 2 email templates
- Host: GitHub
- URL: https://github.com/ubermanu/magento2-email
- Owner: ubermanu
- License: mit
- Created: 2019-11-23T11:32:22.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-03-11T16:18:52.000Z (over 4 years ago)
- Last Synced: 2025-05-06T21:08:20.105Z (about 1 year ago)
- Topics: cli, email, magento2, testing
- Language: PHP
- Homepage:
- Size: 20.5 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Magento 2 - Email testing
Console commands to generate an email based on the available templates.
## Install
composer require ubermanu/magento2-email
## Usage
List the available email templates:
php bin/magento email:list
Generate an email and send it:
php bin/magento email:send \
--template customer_create_account_email_template \
--store 0 \
test@domain.com
Generate an email and dump its content:
php bin/magento email:dump \
--template customer_create_account_email_template \
--store 0
## Variables
It is possible to inject variables in the generated email using a YAML file.
For example:
```yaml
customer:
id: 1
name: John Doe
email: john@example.com
rp_token: 123456789
```
And use this data in the email:
php bin/magento email:send \
--template customer_create_account_email_template \
--vars variables.yaml \
test@domain.com
## Notes
The email should be translated according to the given store language.
It's not possible to send an email with frontend compilation enabled.
[Emogrifier](https://github.com/MyIntervals/emogrifier) won't be able to parse the generated HTML if it's not properly compiled to CSS first.