Download the PHP package rennokki/laravel-mjml without Composer
On this page you can find all versions of the php package rennokki/laravel-mjml. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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 laravel-mjml
Laravel MJML
Laravel MJML is a simple API wrapper for the MJML.io Render API. In case you don't know what MJML.io is, it is a language that helps building mails easier and faster without messing up with inline HTML. It has its own syntax that can be later rendered using their apps, online editor or their API.
This API wrapper comes with Mustache Engine integrated, so you can both render the MJML to HTML with applied values from Mustache.
If you don't know what Mustache is check this Medium article that explains better Mustahce and gets you started on how to use it in your email.
Installation
Install the package:
If your Laravel version does not support package discovery, add this line in the providers array in your config/app.php file:
Setting up the API
Since it is an API, you'll need credentials. For this, you will have to request yours from their API page: https://mjml.io/api by clicking Join the beta. It will take some time to get yours, so be patient.
To authenticate the API, you will have to call the Rennokki\LaravelMJML\LaravelMJML class and then, by chaining methods, to add your App ID and your Secret Key.
Note: when making requests from the backend, just the Secret Key is required. If you plan to do it from the frontend, you will have to use your provided Public Key instead, since storing sensitive credentials in frontend is not possible.
Starting MJML
As MJML code, we'll use this throughout the readme:
Rendering
When rendering, simply calling the render() method will do the work for you:
As a return, you will get the compiled HTML. In case this rendering failed, due to reasons, you will get null, for example:
Rendering with Mustache
If you got started with Mustache, you can render the MJML to HTML and then render the Mustache variables in your compiled HTML using the same method.
For this example, our MJML would look like this:
You can call renderWithMustache method with MJML and an array which consist the parameters that need to injected:
