Skip to content

docs: Document what Ghost's nodemailer wrapper is doing. #209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Document what Ghost's nodemailer wrapper is doing. #209

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 20 additions & 5 deletions packages/nodemailer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,31 @@
# Nodemailer

## Install
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.

`npm install @tryghost/nodemailer --save`
See the [official docs for configurating transaction email sending for Ghost](https://ghost.org/docs/config/#mail).

or
## Description

`yarn add @tryghost/nodemailer`
Provides pre-configured transport options for common transport services.

### Supported Transport Types

## Usage
1. `smtp` - send via SMTP server.
* Detects when service: 'sendmail' is used and enables sendmail mode

2. `mailgun` - Allows using Mailgun with API key instead of via SMTP.
* `auth: { api_key: 'your-mailgun-api-key' }`
* Defaults to 60-second timeout.

3. `sendmail` - use local sendmail binary.

4. `ses` - [Send via AWS SES](https://ghost.org/docs/config/#amazon-ses).

5. `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.

6. `stub` - For testing and development. Doesn't actually send mail.

Other Nodemailer transports are not supported.

## Develop

Expand Down