README

This is a companion package to mjml-php that runs compilation through Sidecar instead.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require spatie/mjml-sidecar

Register the MjmlFunction in your sidecar.php config file.

/*
 * All of your function classes that you'd like to deploy go here.
 */
'functions' => [
    \Spatie\MjmlSidecar\MjmlFunction::class,
],

Deploy the Lambda function by running:

php artisan sidecar:deploy --activate

See the Sidecar documentation for details.

Usage

For usage, check the mjml-php documentation.

All the methods are available, just make sure to add ->sidecar(), for example:

Mjml::new()->sidecar()->toHtml($mjml);

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Rias Van der Veken
• All Contributors

License

The MIT License (MIT). Please see License File for more information.