[!TIP] No time to code? Check out the CLI tool based on this client SDK to get started quickly!

Features

Interested in the state of the project? Check the faq!

• [x] Export
  • [x] Export complete user data
  • [x] Export aliases as CSV
• [x] Account Management
  • [x] Login (+MFA), Register, Activate, Reactivate
  • [x] Password reset
  • [x] User info and statistics
  • [x] API key management
  • [x] Cookie token generation
  • [x] Logout
  • [x] Sudo mode
  • [x] Account deletion
• [x] Alias Management
  • [x] Get alias options
  • [x] Create (random and custom), Update, Delete
  • [x] Contacts and activities
• [x] Mailbox Management
  • [x] Get, Create, Update, Delete
• [x] Contact Management
  • [x] Get, Create
  • [x] Delete
  • [x] Block & unblock
• [x] Settings
  • [x] Read and write settings
  • [x] Read random alias domains
• [x] Custom Domain Management
  • [x] Get domains
  • [x] Update domain settings
  • [x] View trash (deleted aliases)
• [ ] Notifications
  • [ ] Get notifications
  • [ ] Mark notification as read
• [ ] Phone & Misc
  • [ ] Phone reservation message retrieval
  • [ ] Apple payment processing

Getting started

simplelogin-client works in most NodeJS versions and browsers, but may require a tweak when not used with NodeJS 18 or in outdated browsers. Check the compatibility guide.

To start using this API client in your JS/TS projects:

# Install dependency
npm install --save simplelogin-client

import { SimpleLoginClient } from 'simplelogin-client';

const { alias } = new SimpleLoginClient({
  apiKey: process.env.API_KEY,
})

const createdAlias = await alias.createRandomAlias({
  note: 'This alias was created with simplelogin-client!',
});

console.log(createdAlias);
/* Output:
{
  id: 50001,
  creation_date: '2023-02-10 20:19:37+00:00',
  alias: '[email protected]',
  mailbox: { email: '[email protected]', id: 50001 },
  enabled: true,
  pinned: false,
  note: "This alias was created with simplelogin-client!",
  ...
}
*/

Check the documentation for all available methods and the FAQ in case of questions.

:bangbang: Please don't contact the SimpleLogin team with issues regarding this client. Instead open an issue in this repository.

Development

Want to contribute fixes to the API client or spec? Check the development guide!