ts-ulm-dsl

Typescript library for fetching emails from the temp mail service ulm-dsl.

Installation

Available on npm.

npm install ts-ulm-dsl

Usage

The following examples use the email address [email protected]. Just replace the inbox name max.mustermann to match your address.

Every method is async and therefore returns a promise. You can either use await to resolve the promise or use the .then() method to execute a callback as soon as the promise settles.

Note that you have to fetch your inbox once before you can receive emails at your address. Your address stays active for 14 days. This period renews for every request.

Initialization

Just import the client from your node_modules.

import ulmDslClient from "ts-ulm-dsl";

Get Inbox

You can fetch the basic information except the body for all emails in an inbox by calling the getInbox method and passing the inbox name.

const emails = await ulmDslClient.getInbox("max.mustermann");

Get Mail by Id

You can get all available information for a specific email by calling the getMailById method and passing the inbox name and email identifier.

const email = await ulmDslClient.getMailById("max.mustermann", 7);

Get Mails

You can get all available information for all emails in an inbox by calling the getMails method and passing the inbox name.

const emails = await ulmDslClient.getMails("max.mustermann");

API rate limits

The api is limited to about 100 requests per minute. So you should keep in mind when this client fires requests:

• When you fetch your inbox only a single request gets fired.
• When you fetch a specific email by id, two requests get fired. One for the basic information e.g. the sender and receiver and one for the email body.
• When you fetch all emails a first request gets fired for the basic information of all emails and then another request per email to retrieve each email body.

So based on your inbox size you should think twice before you fetch all emails. Maybe it's better to just fetch the inbox and then retrieve a single email by id.

Related

Here are some related projects:

• CSharpUlmDsl: C# version of this library