@tryghost/nodemailer
v1.2.1
Published
This is a wrapper around the [nodemailer](https://nodemailer.com/) module for use internally by [Ghost](https://ghost.org/). It is not intended to be installed or used outside of Ghost.
Maintainers
Keywords
Readme
Nodemailer
This is a wrapper around the nodemailer module for use internally by Ghost. It is not intended to be installed or used outside of Ghost.
See the official docs for configurating transaction email sending for Ghost.
Description
Provides pre-configured transport options for common transport services.
Supported Transport Types
smtp- send via SMTP server.
- Detects when service: 'sendmail' is used and enables sendmail mode
mailgun- Allows using Mailgun with API key instead of via SMTP.
auth: { api_key: 'your-mailgun-api-key' }- Defaults to 60-second timeout.
sendmail- use local sendmail binary.ses- Send via AWS SES.direct- Attempt to connect directly to remote SMTP servers. This is the default and requires no configuration, but is more likely to be blocked by remote mail services.stub- For testing and development. Doesn't actually send mail.
Other Nodemailer transports are not supported.
Purpose
Factory for creating Nodemailer transports across SMTP, SES, Mailgun, Sendmail, and test/stub transports.
Develop
This is a mono repository, managed with lerna.
Follow the instructions for the top-level repo.
git clonethis repo &cdinto it as usual- Run
yarnto install top-level dependencies.
Run
yarn dev
Test
yarn lintrun just eslintyarn testrun lint and tests
Copyright & License
Copyright (c) 2013-2026 Ghost Foundation - Released under the MIT license.
