Download the PHP package spatie/mjml-php without Composer
On this page you can find all versions of the php package spatie/mjml-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download spatie/mjml-php
More information about spatie/mjml-php
Files in spatie/mjml-php
Package mjml-php
Short Description Convert MJML to HTML using PHP
License MIT
Homepage https://github.com/spatie/mjml-php
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package mjml-php
Convert MJML to HTML using PHP
MJML is a markup language designed to reduce the pain of coding a responsive email. Our mjml-php package can convert MJML to HTML.
Here's an example of how to use our package:
The returned HTML will look like the HTML in this snapshot file (it's a bit too large to inline in this readme). Most email clients will be able to render this HTML perfectly.
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:
In your project, or on your server, you must have the JavaScript package mjml installed.
... or Yarn.
Make sure you have installed Node 16 or higher.
Usage
The easiest way to convert MJML to HTML is by using the toHtml() method.
If the MJML could not be converted at all a Spatie\Mjml\Exceptions\CouldNotRenderMjml exception will be thrown.
Using convert()
The toHtml() method will just return the converted HTML. There's also a convert() method that will return an instance of Spatie\Mjml\MjmlResult that contains the converted HTML and some metadata.
On the returned instance of Spatie\Mjml\MjmlResult you can call the following methods:
html(): returns the converted HTMLarray(): returns a structured version of the given MJMLhasErrors(): returns a boolean indicating if there were errors while converting the MJMLerrors(): returns an array of errors that occurred while converting the MJML
The errors() method returns an array containing instances of Spatie\Mjml\MjmlError. Each Spatie\Mjml\MjmlError has the following methods:
line(): returns the line number where the error occurredmessage(): returns the error messageformattedMessage(): returns the error message with the line number prependedtagName(): returns the name of the tag where the error occurred
Customizing the rendering
There are various methods you can call on the Mjml class to customize the rendering. For instance the minify() method will minify the HTML that is returned.
These are all the methods you can call on the Mjml class:
minify(): minify the HTML that is returnedbeautify(): beautify the HTML that is returnedhideComments(): hide comments in the HTML that is returnedvalidationLevel(ValidationLevel $validationLevel): set the validation level tostrict,softorskip
Instead of using these dedicated methods, you could opt to pass an array with options as the second argument of the toHtml or convert method. You can use any of the options that are mentioned in the MJML documentation for Node.js.
Validating MJML
You can make sure a piece of MJML is valid by using the canConvert() method.
If true is returned we'll be able to convert the given MJML to HTML. However, there may still be some errors while converting the MJML to HTML. These errors are not fatal and the MJML will still be converted to HTML. You can see these non-fatal errors when calling errors() on the MjmlResult instance that is returned when calling convert.
You can use canConvertWithoutErrors to make sure the MJML is both valid and that there are no non-fatal errors while converting it to HTML.
Specifying the path to nodejs executable
By default, the package itself will try to determine the path to the node executable. If the package can't find a path, you can specify a path in the environment variable MJML_NODE_PATH
Sidecar
This package also supports running through Sidecar in Laravel projects.
To use the ->sidecar() method, a few extra steps are needed:
Install the Sidecar package:
Register the MjmlFunction in your sidecar.php config file.
Deploy the Lambda function by running:
See the Sidecar documentation for details.
Testing
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
- Freek Van der Herten
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
