https://github.com/fritx/gulp-mail

Send mails with gulp
https://github.com/fritx/gulp-mail

gulp mail

Last synced: 3 months ago
JSON representation

Send mails with gulp

• Host: GitHub
• URL: https://github.com/fritx/gulp-mail
• Owner: fritx
• Created: 2014-09-11T14:35:01.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2022-09-24T17:05:15.000Z (over 2 years ago)
• Last Synced: 2024-10-12T22:16:02.830Z (3 months ago)
• Topics: gulp, mail
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/gulp-mail
• Size: 12.7 KB
• Stars: 7
• Watchers: 5
• Forks: 11
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## gulp-mail

  

A [gulp](https://github.com/gulpjs/gulp) wrapper for [Nodemailer](https://nodemailer.com) used to quickly send emails from tasks and/or the command-line during development or testing.

`gulp-mail` is based on [gulp-mailer](https://github.com/meerkats/gulp-mailer), which is not available on [npm](https://www.npmjs.com/).

### Installation

Installing via [npm](https://www.npmjs.org/package/gulp-mail):

```sh

npm install --save-dev gulp-mail

```

### Usage

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

```js

var gulp = require('gulp');

var mail = require('gulp-mail');

var smtpInfo = {

  auth: {

    user: '[email protected]',

    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: [

        '[email protected]'

      ],

      from: 'Foo ',

      smtp: smtpInfo

    }));

});

```