Exports Reference

Everything exported from @impruthvi/nodemail (src/index.ts):

Classes

ExportDescription
MailStatic facade -- configure(), to(), send(), fake(), assertions
MailManagerFactory and manager for mail providers
MailableAbstract base class for reusable email definitions
MessageLow-level message builder with fluent API
FailoverManagerOrchestrates provider failover
SmtpProviderSMTP provider (Nodemailer)
SendGridProviderSendGrid provider
SesProviderAWS SES provider
MailgunProviderMailgun provider
ResendProviderResend provider
PostmarkProviderPostmark provider
HandlebarsEngineHandlebars template engine
EjsEngineEJS template engine
PugEnginePug template engine
QueueManagerQueue management
BullMQDriverBullMQ queue driver
BullDriverBull (legacy) queue driver
MarkdownRendererMarkdown-to-HTML renderer
MarkdownMailableAbstract mailable with markdown support
MailFakeFake mail provider for testing
AssertableMessageMessage wrapper with assertion helpers

Functions

ExportDescription
getDefaultTheme()Returns the default MarkdownTheme

Constants

ExportValueDescription
VERSION'1.0.0'Package version

Types

ExportDescription
TemplateEngineTemplate engine interface
TemplateEngineOptionsTemplate engine constructor options
MarkdownRendererOptionsMarkdown renderer options
MarkdownThemeMarkdown theme interface
SentMessageShape of a stored sent message
MailConfigTop-level configuration object
MailerConfigIndividual mailer configuration
SmtpConfigSMTP provider configuration
SendGridConfigSendGrid provider configuration
SesConfigAWS SES provider configuration
MailgunConfigMailgun provider configuration
ResendConfigResend provider configuration
PostmarkConfigPostmark provider configuration
MailtrapConfigMailtrap provider configuration
MailAddressEmail address with optional display name
AttachmentEmail attachment definition
MailOptionsFull mail options for sending
MailProviderProvider interface
MailResponseResponse from sending an email
FailoverConfigFailover chain configuration
FailoverEventFailover callback event data
FailoverDetailIndividual failover attempt detail
QueueConfigQueue system configuration
RedisConnectionConfigRedis connection options
BackoffConfigQueue retry backoff settings
QueuedMailJobQueued mail job definition
QueueJobResultResult of queuing a job
QueueDriverQueue driver interface
TemplateConfigTemplate system configuration
MarkdownConfigMarkdown mail configuration