All Classes and Interfaces
Class
Description
Shared base class for
<mj-section> and <mj-wrapper>.Attribute cascade state gathered during head processing.
Resolves attributes for a component using the 5-level cascade:
Inline attributes (on the element itself)
mj-class attributes
Tag-specific default attributes (mj-attributes > mj-section, etc.)
Builds CSS background-related style maps for sections and wrappers.
Normalizes CSS background-position values to "x y" format.
Abstract base class for all MJML components.
Abstract base for body components that render to HTML.
Resolves mj-include paths from the classpath.
Calculates column pixel widths and responsive width specifications from a list of column nodes
and a container width.
Functional interface for creating component instances from parsed nodes.
Registry mapping MJML tag names to component factories.
Functional interface for creating container component instances that need access to the
ComponentRegistry in order to instantiate and render child components.Optional hook for sanitizing HTML content within
<mj-text>, <mj-button>, and
<mj-raw> elements.Calculates padding and border box dimensions from CSS shorthand values.
A single CSS property declaration, e.g.
Utility to escape values for safe interpolation into CSS contexts.
Inlines CSS styles into HTML elements' style attributes.
Parses CSS text into a list of
CssRule objects.Result of parsing CSS: regular rules to inline and preserved at-rules.
A CSS rule consisting of a selector string and a list of declarations.
Sealed hierarchy of CSS selectors.
Attribute selector with operator.
A class selector (e.g. ".red").
CSS combinator types used between selectors in a complex selector.
A complex selector joining two selectors with a combinator (e.g.
A compound selector consisting of a chain of simple selectors with no combinator (e.g.
An ID selector (e.g.
A pseudo-class selector (e.g.
A pseudo-element selector (e.g.
A comma-separated list of selectors (e.g.
A single simple selector part (type, class, ID, attribute, pseudo-class, or pseudo-element).
A type (element name) selector (e.g.
The universal selector (
*), which matches any element.Matches CSS selectors against
HtmlElement nodes.Recursive-descent parser for CSS selectors.
CSS specificity as an (a, b, c) tuple where:
a = number of ID selectors
b = number of class, attribute, and pseudo-class selectors
c = number of type and pseudo-element selectors
Inline styles have a virtual specificity of (1, 0, 0, 0) which always wins, handled separately by
the inliner.
Parses CSS unit values (px, %, em) and converts them to pixel values.
Registry of well-known web fonts that MJML auto-imports when used in font-family.
Text direction for the HTML document.
Maps HTML5 named entities to their numeric character references.
Resolves mj-include paths from the file system relative to a base directory.
Document-wide context gathered during head processing.
Abstract base for head components (mj-attributes, mj-font, etc.).
Fluent HTML builder that manages indentation automatically.
Lightweight HTML tokenizer that builds an
HtmlElement tree from HTML text.Result of extracting CSS from HTML, containing the cleaned HTML and collected CSS text.
Lightweight HTML element representation for CSS selector matching and style inlining.
Utility to escape HTML special characters in attribute values.
Generates the complete HTML document skeleton wrapping the rendered body.
Processes mj-include elements in the parsed MJML tree.
Interface for resolving mj-include paths to content.
Document-level metadata gathered during head processing.
The accordion component (
<mj-accordion>).A single accordion item (
<mj-accordion-element>).The accordion text component (
<mj-accordion-text>).The accordion title component (
<mj-accordion-title>).Processes mj-attributes to set default attribute values.
The root body component (<mj-body>).
Sets the responsive breakpoint from mj-breakpoint width attribute.
The button component (<mj-button>).
The carousel component (
<mj-carousel>).A single image in a carousel (
<mj-carousel-image>).The column component (<mj-column>).
The divider component (<mj-divider>).
Registers a web font from mj-font attributes (name, href).
The group component (<mj-group>).
The mj-head container component.
The hero component (
<mj-hero>).Processes mj-html-attributes to add custom HTML attributes to output elements.
The image component (<mj-image>).
Configuration for the MJML renderer.
Builder for constructing
MjmlConfiguration instances.Represents an MJML document's structure, containing a root node and methods to access key
elements such as the head and body nodes.
Runtime exception thrown when MJML parsing or rendering fails.
Exception thrown when mj-include processing fails (missing file, circular includes, etc.).
Lightweight mutable tree node representing an MJML element.
Exception thrown when MJML parsing fails (malformed XML, missing root element, etc.).
Parses preprocessed MJML source into an MjmlDocument.
Preprocesses MJML source before XML parsing.
Public API entry point for rendering MJML templates to HTML.
Exception thrown when a failure occurs during the MJML rendering phase (as opposed to parsing or
input validation).
Result of rendering an MJML template to HTML.
Exception thrown when MJML input validation fails (size limit, nesting depth, etc.).
The navbar component (
<mj-navbar>).A single link in a navbar (
<mj-navbar-link>).Sets the preview text (preheader) from mj-preview content.
The raw component (
<mj-raw>).The section component (<mj-section>).
The social component (
<mj-social>).A single social element (
<mj-social-element>).The spacer component (<mj-spacer>).
Adds CSS styles from
<mj-style> content to the rendered HTML.The table component (<mj-table>).
The text component (<mj-text>).
Sets the document title from mj-title content.
The wrapper component (<mj-wrapper>).
Shared helpers for generating MSO/IE conditional comments used by
<mj-section>,
<mj-wrapper>, and <mj-hero>.Per-component render context that carries the current container width as the rendering pipeline
descends the component tree.
Orchestrates the 7-phase rendering pipeline:
Preprocess (handled by MjmlParser)
Parse (handled by MjmlParser)
Resolve includes (expand mj-include)
Process head (extract fonts, styles, attributes, etc.)
Context information passed to
IncludeResolver when resolving includes.Registry of known social networks with default icon URLs, colors, and share URLs.
Describes a social network's display defaults.
Parses, merges, and serializes CSS inline style attributes.
CSS and font state gathered during head processing.
Font definition record.
Media query definition for responsive column widths. widthValue is the numeric value, widthUnit
is "%" or "px".
Helper for generating Outlook VML (Vector Markup Language) for background images.