How nestjs/mail works
This is a NestJS mail module: applications submit inline messages or injectable mail classes, which the mailer validates and renders into immutable messages, then delivers through SMTP or an HTTP provider with retries and events. Templates, MIME construction, and provider-specific adapters are distinct capabilities. The README documents the overall feature set; detailed edges are limited to relationships visible in excerpts or the SOURCE INDEX, so unsampled wiring is not inferred.
Main entry points: mailer.service.ts Mailer service · http-provider.transport.ts HTTP provider base · mail-message.ts Validated mail message · normalize.util.ts Message normalization
Components 25
Mail workflow
- Mailer service
lib/mailer.service.ts - Injectable mail classes
lib/interfaces/mailable.interface.ts - Mail module setup
lib/mail.module-definition.ts
Message and templates
- Validated mail message
lib/message/mail-message.ts - Message normalization
lib/message/normalize.util.ts - Address parsing
lib/message/address.util.ts - Header validation
lib/message/headers.util.ts - MIME builder
lib/message/mime.util.ts - Template engine
lib/templates/mail-template.engine.ts - File template engine
lib/templates/file-template.engine.ts - Template compiler
lib/templates/template-compiler.util.ts
Delivery transports
- Transport contract
lib/transports/mail.transport.ts - SMTP transport
lib/smtp/smtp.transport.ts - SMTP connection
lib/smtp/smtp-connection.ts - HTTP provider base
lib/transports/http-provider.transport.ts - Resend transport
lib/transports/resend.transport.ts - Postmark transport
lib/transports/postmark.transport.ts - SendGrid transport
lib/transports/sendgrid.transport.ts - Amazon SES transport
lib/transports/ses.transport.ts - Local transports
lib/transports
Retry and events
- Retry policy
lib/utils/retry.util.ts - Mail events
lib/events/mail-events.service.ts
Other components
- Nest application
- Mail provider APIs
- SMTP server
Connections 22
- Nest application → Mail module setup: configures
README.md - Nest application → Mailer service: sends mail
README.md - Mailer service → Injectable mail classes: resolves and renders
lib/mailer.service.ts - Mailer service → Message normalization: normalizes
lib/mailer.service.ts - Message normalization → Address parsing: parses addresses
lib/message/normalize.util.ts - Message normalization → Header validation: validates headers
lib/message/normalize.util.ts - Mailer service → Validated mail message: builds
lib/mailer.service.ts - Validated mail message → Address parsing: checks internationalization
lib/message/mail-message.ts - Validated mail message → MIME builder: builds MIME
lib/message/mail-message.ts - Mailer service → Template engine: renders templates
lib/mailer.service.ts - File template engine → Template compiler: compiles templates
lib/templates/file-template.engine.ts - Mailer service → Transport contract: dispatches message
lib/mailer.service.ts - Mailer service → Retry policy: applies retries
lib/mailer.service.ts - Mailer service → Mail events: publishes events
lib/mailer.service.ts - SMTP transport → SMTP connection: uses connection
lib/smtp/smtp.transport.ts - SMTP connection → SMTP server: speaks SMTP
README.md - Resend transport → HTTP provider base: uses HTTP requests
lib/transports/resend.transport.ts - Postmark transport → HTTP provider base: uses HTTP requests
README.md - SendGrid transport → HTTP provider base: uses HTTP requests
README.md - Amazon SES transport → HTTP provider base: uses HTTP requests
lib/transports/ses.transport.ts - HTTP provider base → Mail provider APIs: sends API request
README.md - Local transports → Transport contract: implements alternatives
README.md