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

mailinator-inbox

v1.3.0

Published

Node.js mailinator client to access a public disposable inbox and read emails. Does not require token

Downloads

325

Readme

Node mailinator client

Mailinator client library for nodejs. Access a public disposable email inbox, based on a username, and read emails. Does not require an API key.

Installation

npm install --save mailinator-inbox

Usage

import {Inbox} from "mailinator-inbox"

//Access the inbox of [email protected]
const inbox = new Inbox("johnny");

//Load emails
await inbox.refresh();

//Get the header ( from, subject, ...) of the first email
const firstEmailHeader = inbox.emailHeaders[0];

//Retrieve the whole email, including body
const firstEmail = await inbox.getEmail(firstEmailHeader.id);

//Wait for new emails from [email protected]
const futureEmails = await inbox.waitForEmailsFrom("[email protected]", 15000);

//Iterate over the headers of the new emails from ana
futureEmails.foreach(async (emailInfo) => {
	const email = await inbox.getEmail(emailInfo.id);
	
	console.log("From Ana:", email.subject, email.textBody)
})

API

Class Inbox

new Inbox(username: string)

Creates a new inbox for the given username

emailHeaders: EmailInfo[]

Array with the headers of all the emails in the inbox. These are not the full email, only metadata. You need to call getEmail() to load the body and any additional data.

.refresh()

ASYNC
Obligatory to call before trying to access emails, as this loads the initial email headers. You can call this anytime to refresh the inbox with new emails.

.getEmail(id: string): Email

ASYNC
Retrieves the whole email with the given id. Use the id from emailHeaders.

.getEmailsFrom(address: string): EmailHeader[]

Return a list of all the email headers from the specified address. Does not refresh the emails.

.waitForEmailsFrom(address: string | RegExp, timeout: number): Promise<EmailHeader[]>

ASYNC
Poll for new emails from the given address, can be a regex. Waits until timeout runs out. Stops after the first encounter of a new mail. Returns a list of email headers because there may be multiple new emails, or null if timed out.

EmailHeader

interface EmailHeader {
	id: string;
	subject: string;
	//Email address that sent the email [email protected]
	fromEmail: string;
	//Johhny Doe
	fromName: string;
	//Epoch time when email was received
	time: number;

	//Raw email heaeder as received from mailinator
	mailinatorHeader: MailinatorEmailHeader;
}

Email

class Email {
	id: string;
	subject: string;
	//Epoch time when mail was received
	time: number;
	//Email address that sent the email [email protected]
	fromEmail: string;
	//Johhny Doe
	fromName: string;
	//Email body as text, not always present
	textBody?: string;
	//Email body as HTML
	htmlBody: string;
	//All the URL links from the email
	links: string[];

	//Raw email object as received from mailinator
	mailinatorMail: MailinatorEmail;
}

License

MIT