Component props reference for dash_email.

API reference

dash_email

Email

Email is the root wrapper component for email templates. Renders as an HTML document structure suitable for email preview.

proptypedefaultdescription
idstringThe ID used to identify this component in Dash callbacks.
childrennodeThe children of this component (EmailHead, EmailPreview, EmailBody, etc.)
dirone of 'ltr', 'rtl''ltr'Text direction of the email content.
langstring'en'Language of the email content.
styleobject{}Inline styles for the html element.

EmailBody

EmailBody wraps the main content of the email.

proptypedefaultdescription
idstringThe ID used to identify this component in Dash callbacks.
childrennodeThe children of this component (EmailContainer, EmailSection, etc.)
styleobject{}Inline styles for the body element.

EmailButton

EmailButton renders a styled link that looks like a button.

proptypedefaultdescription
idstringThe ID used to identify this component in Dash callbacks.
childrennodeThe button label/content.
href *stringThe URL to navigate to when clicked.
styleobject{}Inline styles for the button.
targetstring'_blank'Where to open the link (_blank, _self, etc.)

EmailColumn

EmailColumn creates a column within an EmailRow. Uses table cell for email client compatibility.

proptypedefaultdescription
idstringThe ID used to identify this component in Dash callbacks.
childrennodeThe children of this component.
styleobject{}Inline styles for the column.

EmailContainer

EmailContainer centers content horizontally with a max-width.

proptypedefaultdescription
idstringThe ID used to identify this component in Dash callbacks.
childrennodeThe children of this component.
styleobject{}Inline styles for the container.

EmailDivider

EmailDivider renders a horizontal line/divider.

proptypedefaultdescription
idstringThe ID used to identify this component in Dash callbacks.
styleobject{}Inline styles for the divider.

EmailFont

EmailFont loads a custom font for use in the email. In preview mode, this adds a style tag with @font-face.

proptypedefaultdescription
idstringThe ID used to identify this component in Dash callbacks.
fallbackFontFamilystring \list of string'Helvetica'Fallback font family if the web font fails to load.
fontFamily *stringThe font family name.
fontStylestring'normal'Font style (normal, italic).
fontWeightnumber \string400Font weight (400, 700, bold, etc.)
webFontdictWeb font configuration object with url and format properties.

EmailHead

EmailHead contains metadata for the email such as fonts. In preview mode, this renders as a hidden container.

proptypedefaultdescription
idstringThe ID used to identify this component in Dash callbacks.
childrennodeThe children of this component (EmailFont, style elements, etc.)

EmailHeading

EmailHeading renders heading text (h1-h6).

proptypedefaultdescription
idstringThe ID used to identify this component in Dash callbacks.
as_one of 'h1', 'h2', 'h3', 'h4', 'h5', 'h6''h1'The heading level (h1, h2, h3, h4, h5, h6).
childrennodeThe heading text content.
styleobject{}Inline styles for the heading.

EmailImage

EmailImage renders an image in the email.

proptypedefaultdescription
idstringThe ID used to identify this component in Dash callbacks.
altstring''Alternative text for the image.
heightnumber \stringThe height of the image (number or string).
src *stringThe image source URL. Should be an absolute URL for production.
styleobject{}Inline styles for the image.
widthnumber \stringThe width of the image (number or string like "100%").

EmailLink

EmailLink renders a hyperlink in the email.

proptypedefaultdescription
idstringThe ID used to identify this component in Dash callbacks.
childrennodeThe link text/content.
href *stringThe URL to navigate to when clicked.
styleobject{}Inline styles for the link.
targetstring'_blank'Where to open the link (_blank, _self, etc.)

EmailPreview

EmailPreview renders preview text that appears in the inbox before the email is opened. Hidden in the actual email body.

proptypedefaultdescription
idstringThe ID used to identify this component in Dash callbacks.
childrennodeThe preview text to display in email client inboxes.

EmailRow

EmailRow creates a horizontal row for layout purposes. Uses table-based layout for email client compatibility.

proptypedefaultdescription
idstringThe ID used to identify this component in Dash callbacks.
childrennodeThe children of this component (typically EmailColumn components).
styleobject{}Inline styles for the row.

EmailSection

EmailSection groups related content together.

proptypedefaultdescription
idstringThe ID used to identify this component in Dash callbacks.
childrennodeThe children of this component.
styleobject{}Inline styles for the section.

EmailText

EmailText renders paragraph text with proper spacing.

proptypedefaultdescription
idstringThe ID used to identify this component in Dash callbacks.
childrennodeThe text content.
styleobject{}Inline styles for the text.

Note for AI agents: This is the static, prerendered view of an interactive Dash application served because we detected a non-JS user agent. Full prose docs: