Giter Site home page Giter Site logo

gulp-mailing's Introduction

gulp-mailing

A little improved version of fritx/gulp-mail.

Installation

Installing via npm:

npm install --save-dev gulp-mailing

Usage

mail(options)

  • options: Object

Options

gulp-mailing uses Nodemailer v3. Available options for gulp-mailing 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.

options.attachments

Type: Array
This array will be passed to Nodemailer's message object, pleach check its document here for details.

Example

Currently, gulp-mailing takes in piped streams and sends emails via SMTP only.

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

var smtpInfo = {
  auth: {
    user: '[email protected]',
    pass: 'example_password'
  },
  host: 'smtp.example.com',
  secureConnection: true,
  port: 465
};

gulp.task('mail', function () {
  return gulp.src('./mails/i-love-you.html')
    .pipe(mail({
      subject: 'Example',
      to: [
        '[email protected]'
      ],
      from: 'Example <[email protected]>',
      smtp: smtpInfo
    }));
});

gulp-mailing's People

Contributors

applefreak avatar fritx avatar justin713 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.