Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

README.md

TempMail.so API SDK

NPM Version License

Node.js SDK for TempMail.so API - A simple and easy-to-use temporary email API service.

Features

  • Create temporary email inboxes
  • Manage inbox lifecycle
  • Receive and manage emails
  • Full TypeScript support
  • Simple and intuitive API

Installation

npm install temp-mail-so

Quick Start

const TempMailSo = require('temp-mail-so');

// Initialize client
const client = new TempMailSo('YOUR_RAPIDAPI_KEY', 'YOUR_AUTH_TOKEN');

// Create temporary inbox
async function createTemporaryInbox() {
    try {
        // Get available domains
        const domains = await client.getDomains();
        
        // Create inbox (prefix, domain, lifetime in seconds)
        const inbox = await client.createInbox('test', domains[0], 1800);
        console.log('New inbox:', inbox);
        
        // Get received emails
        const emails = await client.listMails(inbox.id);
        console.log('Received emails:', emails);
    } catch (error) {
        console.error('Error:', error);
    }
}

API Documentation

Initialization

const client = new TempMailSo(rapidApiKey, authToken);

Available Methods

getDomains()

Get list of available domains

const domains = await client.getDomains();

createInbox(address, domain, lifespan)

Create a new temporary inbox

  • address: Email prefix
  • domain: Domain name
  • lifespan: Lifetime in seconds, available values: 0, 300, 600, 900, 1200, 1800
const inbox = await client.createInbox('test', 'example.com', 1800);

listInboxes()

Get list of all inboxes

const inboxes = await client.listInboxes();

deleteInbox(inboxId)

Delete specified inbox

await client.deleteInbox('inbox_id');

listMails(inboxId)

Get all emails from specified inbox

const emails = await client.listMails('inbox_id');

getMail(inboxId, mailId)

Get detailed content of specified email

const email = await client.getMail('inbox_id', 'mail_id');

deleteMail(inboxId, mailId)

Delete specified email

await client.deleteMail('inbox_id', 'mail_id');

Error Handling

The SDK uses Promises for asynchronous operations. We recommend using try-catch for error handling:

try {
    const inbox = await client.createInbox('test', 'example.com', 1800);
} catch (error) {
    console.error('Failed to create inbox:', error.message);
}

License

MIT License - See LICENSE file for more details.

Links

Support

If you encounter any issues while using this SDK, please get help through the following channels:

  1. Check the API Documentation
  2. Submit a GitHub Issue
  3. Contact Technical Support