Find file History
Latest commit 036a6cc Jan 4, 2019
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
src Merge pull request #1445 from mjmlio/passport-validator Dec 13, 2018
.npmignore Bring back cli + validation Mar 9, 2017
README.md Doc #1385 : order attributes in array Oct 15, 2018
package.json v4.3.0 Jan 3, 2019
yarn.lock fix #1442 pin all mjml dependencies versions Dec 5, 2018

README.md

Validating MJML

MJML provides a validation layer that helps you building your email. It can detect if you misplaced or mispelled a MJML component, or if you used any unauthorised attribute on a specific component. It supports 3 levels of validation:

  • skip: your document is rendered without going through validation
  • soft: your document is going through validation and is rendered, even if it has errors
  • strict: your document is going through validation and is not rendered if it has any error

By default, the level is set to soft.

In CLI

When using the mjml command line, you can add the option -c.validationLevel or --config.validationLevel with the validation level you want.

Set the validation level to skip (so that the file is not validated) and render the file

mjml --config.validationLevel=skip template.mjml

Alternatively, you can just validate file without rendering it by add ing the --validate option

mjml --validate template.mjml

In Javascript

In Javascript, you can provide the level through the options parameters on mjml2html. Ex: mjml2html(inputMJML, { validationLevel: 'strict' })

strict will raise a MJMLValidationError exception. This object has 2 methods:

  • getErrors returns an array of objects with line, message, tagName as well as a formattedMessage which contains the line, message and tagName concatenated in a sentence.
  • getMessages returns an array of formattedMessage.

When using soft, no exception will be raised. You can get the errors in the object returned by mjml2html. It is the same object returned by getErrors on strict mode.