https://github.com/jhuckaby/pixl-mail
A very simple class for sending e-mail via SMTP or local sendmail.
https://github.com/jhuckaby/pixl-mail
email nodemailer sendmail smtp
Last synced: 11 months ago
JSON representation
A very simple class for sending e-mail via SMTP or local sendmail.
- Host: GitHub
- URL: https://github.com/jhuckaby/pixl-mail
- Owner: jhuckaby
- Created: 2015-05-30T20:43:32.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-09-27T05:08:53.000Z (over 1 year ago)
- Last Synced: 2024-12-03T07:08:01.723Z (over 1 year ago)
- Topics: email, nodemailer, sendmail, smtp
- Language: JavaScript
- Homepage:
- Size: 19.5 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Table of Contents
- [Overview](#overview)
- [Usage](#usage)
* [Placeholder Substitution](#placeholder-substitution)
* [Loading From Files](#loading-from-files)
* [Attachments](#attachments)
* [HTML Emails](#html-emails)
* [Options](#options)
* [Logging](#logging)
* [Debugging](#debugging)
- [License](#license)
# Overview
This module provides a very simple e-mail sender, which leans heavily on the awesome [nodemailer](https://nodemailer.com/) package. It layers on the ability to pass in a complete e-mail message with headers and body in one string (or file), and optionally perform placeholder substitution using [sub()](https://www.npmjs.com/package/pixl-tools#sub) from the [pixl-tools](https://www.npmjs.com/package/pixl-tools) package. Auto-detects HTML or plain text e-mail body, and supports custom headers and attachments as well.
# Usage
Use [npm](https://www.npmjs.com/) to install the module:
```sh
npm install pixl-mail
```
Then use `require()` to load it in your code:
```js
const PixlMail = require('pixl-mail');
```
Instantiate a mailer object and pass in the SMTP hostname (defaults to `127.0.0.1`) and the port number (defaults to `25`):
```js
let mail = new PixlMail( 'smtp.myserver.com', 25 );
let mail = new PixlMail( '127.0.0.1' );
let mail = new PixlMail();
```
Send mail using the `send()` method. Pass in the complete e-mail message as a multi-line string including `To`, `From` and `Subject` headers, and a callback:
```js
let message =
"To: president@whitehouse.gov\n" +
"From: citizen@email.com\n" +
"Subject: State Budget\n" +
"\n" +
"Dear Mr. President,\nOur state needs more money.\n";
mail.send( message, function(err) {
if (err) console.error( "Mail Error: " + err );
} );
```
For multiple recipients, simply separate them by commas on the `To` line. You can also specify `Cc` and/or `Bcc` headers, as well as any custom MIME headers.
## Placeholder Substitution
The library supports a simple e-mail templating system, where you can insert `[bracket_placeholders]` in your e-mail message, and have the library fill them with appropriate content from a separate object. This feature uses the [sub()](https://github.com/jhuckaby/pixl-tools#sub) function from the [pixl-tools](https://github.com/jhuckaby/pixl-tools) package.
As an example, imagine a welcome e-mail for a new user who has signed up for your app. You have the welcome e-mail "template" stored separately, and want to fill in the user's e-mail address, full name and username at sending time. Here is how to do this:
```js
// email template
let message =
"To: [email]\n" +
"From: support@myapp.com\n" +
"Subject: Welcome to My App, [full_name]!\n" +
"\n" +
"Dear [full_name],\nWelcome to My App! Your username is '[username]'.\n";
// placeholder args
let user = {
username: "jhuckaby",
full_name: "Joseph Huckaby",
email: "jhuckaby@email.com"
};
mail.send( message, user, function(err) {
if (err) console.log(err);
} );
```
So in this case our e-mail template has several placeholders, including `[email]`, `[full_name]` and `[username]`. These are pulled from the `user` object which is passed to `send()` as the 2nd argument. So the final e-mail that would be sent is:
```
To: jhuckaby@email.com
From: support@myapp.com
Subject: Welcome to My App, Joseph Huckaby!
Dear Joseph Huckaby,
Welcome to My App! Your username is 'jhuckaby'.
```
You can actually use a complex hash / array tree of arguments, and then specify `[filesystem/style/paths]` or `[dot.style.paths]` in your placeholders. See the [sub()](https://github.com/jhuckaby/pixl-tools#sub) docs for details.
## Loading From Files
You can specify a file path instead of the raw message, like this:
```js
let user = {
username: "jhuckaby",
full_name: "Joseph Huckaby",
email: "jhuckaby@email.com"
};
mail.send( "conf/emails/new_user_welcome.txt", user, function(err) {
if (err) console.log(err);
} );
```
## Attachments
To attach files, include an `attachments` array in your `args` object, and specify a `filename` and `path` for each one. This is passed directly to [nodemailer](https://nodemailer.com/), so you can use all of their attachment features. Example:
```js
let args = {
attachments: [
{ filename: "contract.pdf", path: "files/contracts/4573D.PDF" },
{ filename: "policy.pdf", path: "files/misc/POLICY-2015.PDF" }
]
};
mail.send( message, args, function(err) {
if (err) console.error( "Mail Error: " + err );
} );
```
For details, see the [Attachments](https://nodemailer.com/message/attachments/) section in the [nodemailer](https://nodemailer.com/) docs.
## HTML Emails
If you want to send HTML formatted e-mails, the library will automatically detect this. Just provide the headers in plain text, two end-of-lines, then start your HTML markup. Example:
```js
let message =
"To: president@whitehouse.gov\n" +
"From: citizen@email.com\n" +
"Subject: State Budget\n" +
"\n" +
"
Dear Mr. President,
\nPlease give our state more money.
\n";
mail.send( message, function(err) {
if (err) console.error( "Mail Error: " + err );
} );
```
**Note:** Your e-mail body must begin with an HTML tag for it to be recognized.
## Options
You can set a number of options using the `setOption()` or `setOptions()` methods. These are passed directly to the underlying [nodemailer](https://nodemailer.com/) module, so please check out their documentation for details. Examples include setting timeouts, SSL, and authentication.
The `setOption()` method takes one single key/value to set or replace, while `setOptions()` accepts an object containing multiple keys/values.
```js
mail.setOption( 'secure', true ); // use ssl
mail.setOption( 'auth', { user: 'fsmith', pass: '12345' } );
mail.setOptions({
connectionTimeout: 10000, // milliseconds
greetingTimeout: 10000, // milliseconds
socketTimeout: 10000 // milliseconds
});
```
You can also use local [sendmail](https://nodemailer.com/transports/sendmail/), if you have that configured on your server. To do this, set the following options, and tune as needed:
```js
mail.setOptions({
"sendmail": true,
"newline": "unix",
"path": "/usr/sbin/sendmail"
});
```
## Logging
You can optionally attach a [pixl-logger](https://github.com/jhuckaby/pixl-logger) compatible log agent, which will log all the [nodemailer](https://nodemailer.com/) debug messages at level 9, with the component column set to `Mailer`. To use this feature, call the `attachLogAgent()` method on your class instance, and pass in your pixl-logger instance:
```js
mail.attachLogAgent( logger );
```
## Debugging
The `send()` method actually returns three arguments: the error (if any), the final composed mail body with headers (after all macro expansion), and a full debug log capture from [nodemailer](https://nodemailer.com/). Here is how to use them:
```js
mail.send( message, function(err, message, log) {
if (err) console.error( "Mail Error: " + err );
console.log( "Full composed message: " + message );
log.forEach( function(row) {
console.log( ...row );
} );
} );
```
Each log row will contain two elements: the log message itself, and an object containing additional metadata. These come directly from [nodemailer](https://nodemailer.com/). Here is an example excerpt:
```
Creating transport: nodemailer (6.4.11; +https://nodemailer.com/; SMTP/6.4.11[client:6.4.11])
{"component":"mail","tnx":"create"}
Sending mail using SMTP/6.4.11[client:6.4.11]
{"component":"mail","tnx":"transport","name":"SMTP","version":"6.4.11[client:6.4.11]","action":"send"}
Resolved localhost as ::1 [cache miss]
{"component":"smtp-connection","sid":"N5uAYhHPKsY","tnx":"dns","source":"localhost","resolved":"::1","cached":false}
Connection established to ::1:25
{"component":"smtp-connection","sid":"N5uAYhHPKsY","tnx":"network","localAddress":"::1","localPort":53068,"remoteAddress":"::1","remotePort":25}
220 joemax.local ESMTP Postfix
{"component":"smtp-connection","sid":"N5uAYhHPKsY","tnx":"server"}
EHLO joemax.local
{"component":"smtp-connection","sid":"N5uAYhHPKsY","tnx":"client"}
```
# License
**The MIT License (MIT)**
*Copyright (c) 2015 - 2024 Joseph Huckaby.*
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.