https://github.com/collaborne/nodemailer-ses-sender
Send emails through SES with Nodemailer (wrapper for the SES transport in Nodemailer)
https://github.com/collaborne/nodemailer-ses-sender
Last synced: about 2 months ago
JSON representation
Send emails through SES with Nodemailer (wrapper for the SES transport in Nodemailer)
- Host: GitHub
- URL: https://github.com/collaborne/nodemailer-ses-sender
- Owner: Collaborne
- License: apache-2.0
- Created: 2017-12-04T16:41:19.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-04-22T11:08:27.000Z (about 5 years ago)
- Last Synced: 2025-03-16T06:14:22.265Z (3 months ago)
- Language: TypeScript
- Size: 64.5 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nodemailer-ses-sender [](https://travis-ci.org/Collaborne/nodemailer-ses-sender) [](https://greenkeeper.io/)
Send emails through SES with Nodemailer (wrapper for the SES transport in Nodemailer)
## Usage
This module requires the environment variables `AWS_PROFILE` (or the individual `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`) and `AWS_REGION` to be set.
```js
const emailSender = new EmailsSender();
emailSender.sendEmail({
from: '[email protected]',
tags: {
'myTag': 'test-email'
},
html: 'This is the content of this test email',
subject: 'Test Nodemailer SES',
receiver: '[email protected]'
})
```
### Dry Run
To test the email sending against a local SMTP server, create the `EmailSender` with a flag, providing host and port of the SMTP server.
```js
const emailSender = new EmailsSender(true, {smtpHost: '127.0.0.1', smtpPort: '587'});
```
> If not provided, SMTP host and port will default to `{smtpHost: '127.0.0.1', smtpPort: '587'}`
To see how to start a local SMTP server that outputs the emails to `STDOUT`, check out `./sample/start-smtp-server.js`
## Development
### VSCode Config
#### Local SMTP Server
```json
{
"type": "node",
"request": "launch",
"name": "Start SMTP Server",
"program": "${workspaceFolder}/sample/start-smtp-server.js",
"env": {
"SMTP_PORT": "587"
}
}
```
#### Send sample message to yourself
```js
{
"type": "node",
"request": "launch",
"name": "Send test email",
"program": "${workspaceFolder}/sample/send-test-email.js",
"args": [
"--dry-run",
"--receiver",
"",
"--sender",
""
],
"env": {
"AWS_PROFILE": "",
"AWS_REGION": "",
"SMTP_PORT": "587"
}
}
```