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

mailisk

v2.0.0

Published

Mailisk library for NodeJS

Downloads

27,371

Readme

Mailisk Node Client

Mailisk is an end-to-end email testing platform. It allows you to receive emails with code and automate email tests.

  • Get a unique subdomain and unlimited email addresses for free.
  • Easily automate E2E password reset and account verification by catching emails.
  • Virtual SMTP support to test outbound email without 3rd party clients.

Get started

For a more step-by-step walkthrough see the NodeJS Guide.

Installation

Install with npm

npm install --save-dev mailisk

Install with Yarn

yarn add mailisk --dev

Usage

After installing the library import it and set the API Key

const { MailiskClient } = require("mailisk");

// create client
const mailisk = new MailiskClient({ apiKey: "YOUR_API_KEY" });

// send email (using virtual SMTP)
await client.sendVirtualEmail(namespace, {
  from: "[email protected]",
  to: `john@${namespace}.mailisk.net`,
  subject: "Testing",
  text: "This is a test.",
});

// receive email
const result = await client.searchInbox(namespace);

console.log(result);

API Reference

This library wraps the REST API endpoints. Find out more in the API Reference.

Client functions

searchInbox(namespace, params?)

The searchInbox function takes a namespace and call parameters.

  • By default it uses the wait flag. This means the call won't return until at least one email is received. Disabling this flag via wait: false can cause it to return an empty response immediately.
  • The request timeout is adjustable by passing timeout in the request options. By default it uses a timeout of 5 minutes.
  • By default from_timestamp is set to current timestamp - 5 seconds. This ensures that only new emails are returned. Without this, older emails would also be returned, potentially disrupting you if you were waiting for a specific email. This can be overriden by passing the from_timestamp parameter (from_timestmap: 0 will disable filtering by email age).
// timeout of 5 minutes
await mailisk.searchInbox(namespace);
// timeout of 1 minute
await mailisk.searchInbox(namespace, {}, { timeout: 1000 * 60 });
// returns immediately, even if the result would be empty
await mailisk.searchInbox(namespace, { wait: false });

Filter by destination address

A common use case is filtering the returned emails by the destination address, this is done using the to_addr_prefix parameter.

const { data: emails } = await mailisk.searchInbox(namespace, {
  to_addr_prefix: "[email protected]",
});

For more parameter options see the endpoint reference.

sendVirtualEmail(namespace, params)

Send an email using Virtual SMTP. This will fetch the SMTP settings for the selected namespace and send an email. These emails can only be sent to an address that ends in @{namespace}.mailisk.net.

const namespace = "mynamespace";

await mailisk.sendVirtualEmail(namespace, {
  from: "[email protected]",
  to: `john@${namespace}.mailisk.net`,
  subject: "This is a test",
  text: "Testing",
});

This does not call an API endpoint but rather uses nodemailer to send an email using SMTP.

listNamespaces()

List all namespaces associated with the current API Key.

const namespacesResponse = await mailisk.listNamespaces();

// will be ['namespace1', 'namespace2']
const namespaces = namespacesResponse.map((nr) => nr.namespace);