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

@mmsb/nodemailer-wrapper

v1.0.0

Published

Wrapper for nodemailer with twig templates from a server

Downloads

3

Readme

nodemailer-wrapper

Usage server side

1. Use mailerFactory to create the mailer

import { mailerFactory from 'nodemailer-wrapper'

const mailer = mailerFactory(
  mailerTransportSettings
  defaultMailerName
  defaultMailerAddress
  clientUrl
  mailTemplateDir
  mailerEnforceRecipient (optional)
)

mailerTransportSettings are smtp configuration for nodemailer : https://nodemailer.com/smtp/ Example :

nodemailer.createTransport({
  host: "smtp.example.com",
  port: 587,
  secure: false, // upgrade later with STARTTLS
  auth: {
    user: "username",
    pass: "password",
  },
});

defaultMailerName is the sender of the mail defaultMailerAddress is the email adress of the server (can be a fake one, but it will not be possible to answer to the emails) clientUrl is the url of your client website mailTemplateDir is the directory where your twig templates are stored (twig templates documentation : https://twig.symfony.com/doc/3.x/templates.html) mailEnforceRecipient is optional for dev purpose, if you give an email adress, all emails will be send to this address

2. Send emails

await Mailer.send(
  {
    to: user_email,
    subject: 'Any subject',
  }, //nodemailer.SendMailOptions
  'my_twig_template', //name of the twig template
  {
    variable_i_want_to_print: "something",
    other_variable: "something else",
  }, //variables that will be used in twig template
);

First argument is nodemailer.SendMailOptions, second one is the name of the twig template to use and third one are the variables used in this twig template. Example of twig template for this example :

{% block content %}
  <p>
    <strong>Dear user,</strong>
  </p>
  <br />

  Here's an email that prints {{variable_i_want_to_print}} and {{other_variable}}
  
  <em>This e-mail is automatically sent to you. Please do not reply to this e-mail address.</em>
{% endblock %}