Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akollade/mjml-bundle
✉️ Symfony bundle for MJML
https://github.com/akollade/mjml-bundle
email hacktoberfest mjml symfony symfony-bundle
Last synced: 2 days ago
JSON representation
✉️ Symfony bundle for MJML
- Host: GitHub
- URL: https://github.com/akollade/mjml-bundle
- Owner: Akollade
- License: mit
- Created: 2017-09-05T18:35:37.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-12-20T08:15:27.000Z (22 days ago)
- Last Synced: 2025-01-01T15:00:56.095Z (9 days ago)
- Topics: email, hacktoberfest, mjml, symfony, symfony-bundle
- Language: PHP
- Homepage:
- Size: 183 KB
- Stars: 109
- Watchers: 4
- Forks: 19
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# MjmlBundle
[](https://packagist.org/packages/notfloran/mjml-bundle)
[](https://packagist.org/packages/notfloran/mjml-bundle)
Bundle to use [MJML](https://mjml.io/) 3 and 4 with Symfony >= 3.
## Installation
### Applications that use Symfony Flex
Open a command console, enter your project directory and execute:
```console
$ composer require notfloran/mjml-bundle
```
### Applications that don't use Symfony Flex
#### Step 1: Download the Bundle
Open a command console, enter your project directory and execute the
following command to download the latest stable version of this bundle:
```console
$ composer require notfloran/mjml-bundle
```
This command requires you to have Composer installed globally, as explained
in the [installation chapter](https://getcomposer.org/doc/00-intro.md)
of the Composer documentation.
#### Step 2: Enable the Bundle
Then, enable the bundle by adding it to the list of registered bundles
in the `app/AppKernel.php` file of your project:
```php
// app/AppKernel.php
// ...
class AppKernel extends Kernel
{
public function registerBundles()
{
$bundles = [
// ...
new NotFloran\MjmlBundle\MjmlBundle(),
];
// ...
}
// ...
}
```
## Renderer
For the moment only one renderer is available, the binary renderer.
### Binary
Install [MJML](https://mjml.io)
```bash
$ npm install mjml
```
Then you need to update the configuration:
```yaml
# config/packages/mjml.yaml
mjml:
renderer: binary # default: binary
options:
binary: '%kernel.project_dir%/node_modules/.bin/mjml' # default: mjml
node: '/Users/user/.nvm/versions/node/v10.16.0/bin/node' # default: null
minify: true # default: false
validation_level: skip # default: strict. See https://mjml.io/documentation/#validating-mjml
```
The `node` option is there for those who have problems with `$PATH`, see [#35](https://github.com/notFloran/mjml-bundle/issues/35).
### Custom
First you must create a class which implements `NotFloran\MjmlBundle\Renderer\RendererInterface`, then declare it as a service.
And finally you have to change the configuration:
````yaml
# config/packages/mjml.yaml
mjml:
renderer: 'service'
options:
service_id: 'App\Mjml\MyCustomRenderer'
````
### PHP Config
If you're using symfony 5 and want to configure this bundle with PHP files instead of YAML:
```php
// config/packages/mjml.php
extension('mjml', [
'renderer' => 'binary',
'options' => [
'binary' => '%kernel.project_dir%/node_modules/.bin/mjml',
'minify' => true,
'validation_level' => 'skip'
]
]);
};
```
### API
The bundle has no official integration with the [MJML API](https://mjml.io/api).
You can create your own integration by using [juanmiguelbesada/mjml-php](https://packagist.org/packages/juanmiguelbesada/mjml-php) and following this gist : https://gist.github.com/notFloran/ea6bab137be628f6a0c19054e08e6906.
## Usage
### Use "mjml" twig tag
```twig
{# mail/example.mjml.twig #}
{% block email_content %}
{% mjml %}
Hello {{ name }} from MJML and Symfony
{% endmjml %}
{% endblock %}
```
```php
public function sendEmail(MailerInterface $mailer)
{
// The MJMl body is rendered by the mjml tag in the twig file
$htmlBody = $this->renderView('templates/mail/example.mjml.twig', ['name' => 'Floran']);
$email = (new Email())
->from('[email protected]')
->to('[email protected]')
->subject('Hello from MJML!')
->html($htmlBody);
$mailer->send($email);
// ...
}
```
### Use "mjml" service
```twig
{# templates/mail/example.mjml.twig #}
Hello {{ name }} from MJML and Symfony
```
```php
use NotFloran\MjmlBundle\Renderer\RendererInterface;
// ...
public function sendEmail(MailerInterface $mailer, RendererInterface $mjml)
{
$mjmlBody = $this->renderView('templates/mail/example.mjml.twig', ['name' => 'Floran']);
$htmlBody = $mjml->render($mjmlBody);
$email = (new Email())
->from('[email protected]')
->to('[email protected]')
->subject('Hello from MJML!')
->html($htmlBody);
$mailer->send($email);
// ...
}
```
## SwiftMailer integration
*❗ This integration is deprecated and will be removed in the next major version.*
Declare the following service:
```yaml
NotFloran\MjmlBundle\SwiftMailer\MjmlPlugin:
tags: [swiftmailer.default.plugin]
```
Create a SwiftMailer message with a MJML body (without `{% mjml %}`) and with `text/mjml` as content-type:
```php
$message = (new \Swift_Message('Hello Email'))
->setFrom('[email protected]')
->setTo('[email protected]')
->setBody(
$this->renderView('mail/example.mjml.twig'),
'text/mjml'
);
$mailer->send($message);
```
The plugin will automatically render the MJML body and replace the body with the rendered HTML.
In the case where a spool is used: the MJML content is save in the spool and render when the spool is flushed.
## License
[MjmlBundle](https://github.com/notFloran/mjml-bundle) is licensed under the [MIT license](LICENSE).