Wondering what’s next for npm?Check out our public roadmap! »

    smtpapi
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/smtpapi package

    1.4.4 • Public • Published

    SendGrid Logo

    BuildStatus npm Email Notifications Badge MIT licensed Twitter Follow GitHub contributors

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

    Announcements

    The default branch name for this repository has been changed to main as of 07/27/2020.

    All updates to this module are documented in our CHANGELOG.

    Table of Contents

    Installation

    Prerequisites

    • Node.js version 4, 5, 6, 7, 8, 10, 12, or 14
    • 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.

    Install smtpapi-nodejs and its dependencies:

    npm install smtpapi

    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

    How to Contribute

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

    Quick links:

    About

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

    If you need help installing or using the library, please check the Twilio SendGrid Support Help Center.

    If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!

    License

    The MIT License (MIT)

    Install

    npm i smtpapi

    DownloadsWeekly Downloads

    39,053

    Version

    1.4.4

    License

    BSD

    Unpacked Size

    195 kB

    Total Files

    24

    Last publish

    Collaborators

    • avatar
    • avatar