A gulp wrapper for Nodemailer used to quickly send emails from tasks and/or the command-line during development or testing.
gulp-mail is based on gulp-mailer, which is not available on npm.
Installing via npm:
npm install --save-dev gulp-mail- options:
Object
gulp-mail uses Nodemailer v0.7.1, which has been deprecated for some time. It is, however, simple and stable. Available options for gulp-mail are:
-
Type:
Object
Contains required SMTP configuration values. (See the example below.) -
Type:
String|Array
A string or array containing one or more than one recipient address, respectively. -
Type:
String
The display name for the sender. -
Type:
String
The email subject line. If not provided, a default subject line is generated from the source filename as[TEST] path.basename. -
Type:
String
The HTML body of the email. If not provided, the source file becomes the message body. -
Type:
String
The plaintext body of the email. If not provided, Nodemailer generates this based on the source file.
Currently, gulp-mail takes in piped streams and sends emails via SMTP only.
var gulp = require('gulp');
var mail = require('gulp-mail');
var smtpConfig = {
host: 'smtp.example.com',
port: 465,
secureConnection: true,
auth: {
user: '[email protected]',
pass: 'correcthorsebatterystaple'
}
};
gulp.task('mail', function () {
return gulp.src('path/to/message.html')
.pipe(mail({
to: [
'[email protected]'
],
from: 'Example <[email protected]>',
subject: 'A message from gulp-mail',
smtp: smtpConfig
}));
});