npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

dpd-email

v0.3.0

Published

Module for Deployd that allows you to send an email to your users

Downloads

50

Readme

Email Resource

Module for Deployd that allows you to send an email to your users.

This is built on Andris Reinmans Nodemailer module.

Installation

$ npm install --save dpd-email

See Installing Modules for details.

Configuration

Before using the email resource, you must go to its Dashboard page and configure it.

Required settings:

host
The hostname of your SMTP provider. Leave this blank to use the DPD_EMAIL_HOST environment variable.

port
The port number of your SMTP provider. Leave this blank to use the DPD_EMAIL_PORT environment variable. Defaults to 25; 587 is also common.

ssl
If checked, use SSL to communicate with your SMTP provider.

username
The SMTP username for your app. Leave this blank to use the DPD_EMAIL_USERNAME environment variable.

password
The SMTP password for your app. Leave this blank to use the DPD_EMAIL_SMTP_PASSWORD environment variable.

Optional settings:

defaultFromAddress
A "from" email address to provide by default. Leave this blank to use the DPD_EMAIL_DEFAULT_FROM environment variable. If this is not provided, you will need to provide this address in every request.

internalOnly
If checked, only allow internal requests (such as those from events) to send emails. Recommended for security.

productionOnly
If checked, attempting to send an email in the development environment will simply print it to the Deployd console.

Usage

To send an email, call dpd.email.post(options, callback) (replacing email with your resource name). The options argument is an object:

{

	// The email address of the sender. Required if defaultFromAddress is not configured.
	// Can be plain ([email protected]) or formatted (Sender Name <[email protected]>)
	from : "",

	// Comma separated list of recipients e-mail addresses that will appear on the To: field
	to : "",

	// Comma separated list of recipients e-mail addresses that will appear on the Cc: field
	cc : "",

	// Comma separated list of recipients e-mail addresses that will appear on the Bcc: field
	bcc : "",

	// The subject of the e-mail.
	subject : "",

	// The plaintext version of the message (can also be generated via templating)
	text : "",

	// The HTML version of the message;
	html : "",
}

Example Usage

// On POST /users

dpd.email.post({
  to      : this.email,
  subject : 'MyApp registration',
  text    : [
  	this.username,
  	'',
  	'Thank you for registering for MyApp!'
  ].join('\n')
}, function ( err, results ) {
	// ...
});

Template

This package no longer provides template feature. You can use

  • [https://www.npmjs.org/package/handlebars]
  • [https://www.npmjs.org/package/ejs]
  • [https://www.npmjs.org/package/lotemplate]

for render html or text before calling dpd.email.post()

Contributors