Node Packaged Masterfully
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    smtpapipublic

    BuildStatus

    This node module allows you to quickly and more easily generate SendGrid X-SMTPAPI headers.

    Announcements

    All updates to this module is documented in our CHANGELOG.

    Installation

    Prerequisites

    • Node.js version 0.10, 0.12 or 4
    • The SendGrid service, starting at the free level

    Environment Variables

    Update your environment with your SendGrid credentials. (if you will be sending via nodemailer or other SMTP transport)

    echo "export SENDGRID_USERNAME='YOUR_USERNAME'" > sendgrid.env
    echo "export SENDGRID_PASSWORD='YOUR_PASSWORD'" >> sendgrid.env
    echo "sendgrid.env" >> .gitignore
    source ./sendgrid.env

    The following recommended installation requires npm. If you are unfamiliar with npm, see the npm docs. Npm comes installed with Node.js since node version 0.8.x therefore you likely already have it.

    Add the following to your package.json file:

    {
      ...
      "dependencies": {
        ...
        "smtpapi": "1.3.1"
      }
    }

    Install smtpapi-nodejs and its dependencies:

    npm install

    Dependencies

    Quick Start

    var smtpapi   = require('smtpapi');
    var header    = new smtpapi();
    header.addTo('test@example.com');
    header.setUniqueArgs({cow: 'chicken'});
    console.log(header.jsonString());

    Usage

    Roadmap

    If you are intersted in the future direction of this project, please take a look at our milestones. We would love to hear your feedback.

    How to Contribute

    We encourage contribution to our projects, please see our CONTRIBUTING guide for details.

    Quick links:

    About

    smtpapi-nodejs is guided and supported by the SendGrid Developer Experience Team.

    smtpapi-nodejs is maintained and funded by SendGrid, Inc. The names and logos for smtpapi-nodejs are trademarks of SendGrid, Inc.

    SendGrid Logo

    install

    npm i smtpapi

    Downloadsweekly downloads

    17,934

    version

    1.3.1

    license

    BSD

    repository

    githubgithub

    last publish

    collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar