gulp-mail
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.
Installation
Installing via npm:
npm install --save-dev gulp-mailUsage
mail(options)
- options:
Object
Options
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:
options.smtp
Type: Object
Contains required SMTP configuration values. (See the example below.)
options.to
Type: String|Array
A string or array containing one or more than one recipient address, respectively.
options.from
Type: String
The display name for the sender.
options.subject
Type: String
The email subject line. If not provided, a default subject line is generated from the source filename as [TEST] path.basename.
options.html
Type: String
The HTML body of the email. If not provided, the source file becomes the message body.
options.text
Type: String
The plaintext body of the email. If not provided, Nodemailer generates this based on the source file.
Example
Currently, gulp-mail takes in piped streams and sends emails via SMTP only.
var gulp = require('gulp');
var mail = require('gulp-mail');
var smtpInfo = {
auth: {
user: 'foo@163.com',
pass: '123456'
},
host: 'smtp.163.com',
secureConnection: true,
port: 465
};
gulp.task('mail', function () {
return gulp.src('./mails/i-love-you.html')
.pipe(mail({
subject: 'Surprise!?',
to: [
'bar@gmail.com'
],
from: 'Foo <foo@163.com>',
smtp: smtpInfo
}));
});