View Source Mjml (mjml v1.4.0)

Provides functions for transpiling MJML email templates to HTML.

Link to this section Summary

Functions

Converts an MJML string to HTML content.

Link to this section Functions

Link to this function

to_html(mjml, opts \\ [])

View Source

Converts an MJML string to HTML content.

Returns a result tuple:

  • {:ok, html} for a successful MJML transpiling
  • {:error, message} for a failed MJML transpiling

You can pass render options to customize the rendering of the final HTML:

  • keep_comments – when false, removes the comments from the rendered HTML. Defaults to true.

  • social_icon_path – when given, uses this base path to generate social icon URLs. E.g. social_icon_path: "https://example.com/icons/" will generate a social icon URL, like "https://example.com/icons/github.png"

examples

Examples

iex> Mjml.to_html("<mjml><mj-head></mj-head></mjml>")
{:ok, "<!doctype html><html xmlns=..."}

iex> Mjml.to_html("something not MJML")
{:error, "Couldn't convert MJML template"}

iex> opts = [keep_comments: false, social_icon_path: "https://example.com/icons/"]
iex> Mjml.to_html("<mjml><mj-head></mj-head></mjml>", opts)
{:ok, "<!doctype html><html xmlns=..."}