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

mailtrap-email-testing

v1.0.1

Published

The `mailtrap-email-testing` package allows you to send emails using the Mailtrap Email Testing API. Follow the steps below to use the package effectively.

Downloads

5

Readme

mailtrap-email-testing Package Usage Guide

The mailtrap-email-testing package allows you to send emails using the Mailtrap Email Testing API. Follow the steps below to use the package effectively.

Prerequisites

Before getting started, make sure you have the following prerequisites:

  • Node.js installed on your machine
  • Mailtrap API credentials (API URL, API Token, Inbox ID)
  • A basic understanding of JavaScript and Node.js

Installation

To use the mailtrap-email-testing package, you need to install it as a dependency in your project. Open your terminal and navigate to your project directory. Then, run the following command:

npm install mailtrap-email-testing

Getting Started

To start using the mailtrap-email-testing package, follow these steps:

  1. Import the package and create an instance of the EmailSender class:
const { EmailSender } = require("mailtrap-email-testing");
const emailSender = new EmailSender({
  apiUrl: process.env.API_URL,
  apiToken: process.env.API_TOKEN,
  inbox_id: process.env.INBOX_ID,
});
  1. Define the required parameters for sending an email:
const params = {
  senderName: "Example Sales Team",
  senderEmail: "[email protected]",
  recipientName: "John Doe",
  recipientEmail: "[email protected]",
  subject: "Your Example Order Confirmation",
  text: "Congratulations on your order no. 1234",
  html: "<html><body><h1>Order Confirmation</h1><p>Congratulations on your order no. 1234</p></body></html>",
  attachments: [
    {
      content: "Base64-encoded content",
      filename: "attachment.txt",
      type: "text/plain",
      disposition: "attachment",
    },
  ],
};

Make sure to replace the placeholder values with your actual email data.

  1. Call the send method to send the email:
emailSender.send(params);

Customization

You can customize the behavior of the EmailSender class by providing the Mailtrap API credentials when creating an instance of the EmailSender class:

const emailSender = new EmailSender({
  apiUrl: "https://api.mailtrap.io",
  apiToken: "YOUR_API_TOKEN",
  inboxId: "YOUR_INBOX_ID",
});

Replace 'YOUR_API_TOKEN' with your Mailtrap API token and 'YOUR_INBOX_ID' with the appropriate inbox ID.

Error Handling

If an error occurs during the email sending process, the send method will throw an error. You can handle errors using a try-catch block:

try {
  // Code for sending email
} catch (error) {
  console.error("Error sending email:", error);
}

That's it! You can now use the mailtrap-email-testing package to send emails using the Mailtrap Email Testing API. Remember to replace the placeholder values and ensure that you have the necessary API credentials before using the package.

If you encounter any issues or have any questions, refer to the package documentation or seek assistance from the Mailtrap support team.

Happy emailing!