API.md

API Reference

Classes

Name	Description
ResponsiveEmailTemplate	No description
TemplatePart	No description

Structs

Name	Description
ParsingOptions	No description
ResponsiveEmailTemplateProps	No description

class ResponsiveEmailTemplate

Implements: IConstruct, IConstruct, IConstruct, IDependable Extends: Construct

Initializer

new ResponsiveEmailTemplate(scope: Construct, id: string, props: ResponsiveEmailTemplateProps)

• scope (Construct) No description
• id (string) No description
• props (ResponsiveEmailTemplateProps) No description
  • htmlPart (TemplatePart) No description
  • subjectPart (string) No description
  • templateName (string) No description
  • parsingOptions (ParsingOptions) No description Optional
  • textPart (TemplatePart) No description Optional

class TemplatePart

Initializer

new TemplatePart()

Properties

Name	Type	Description
source	string
defaultFilePath?	string	Optional

Methods

static fromFile(filePath)

static fromFile(filePath: string): TemplatePart

• filePath (string) No description

Returns:

• TemplatePart

static fromInline(source)

static fromInline(source: string): TemplatePart

• source (string) No description

Returns:

• TemplatePart

struct ParsingOptions

Name	Type	Description
beautify?	boolean	Option to beautify the HTML output. Default: : false
filePath?	string	Full path of the specified file to use when resolving paths from mj-include components. Default: : templateDir or '.'
fonts?	Map<string, string>	Default fonts imported in the HTML rendered by HTML ie. Default: :
keepComments?	boolean	Option to keep comments in the HTML output. Default: : true
minify?	boolean	Option to minify the HTML output. Default: : false
mjmlConfigPath?	string	The path or directory of the .mjmlconfig file default: process.cwd(). Optional
validationLevel?	string	How to validate your MJML. Default: : soft

struct ResponsiveEmailTemplateProps

Name	Type	Description
htmlPart	TemplatePart
subjectPart	string
templateName	string
parsingOptions?	ParsingOptions	Optional
textPart?	TemplatePart	Optional