Package Exports

@mailsac/api
@mailsac/api/mailsac-client.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@mailsac/api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

mailsac-typescript-api

Official Mailsac TypeScript and JavaScript Client Library

Compiled JavaScript files are published here, as well as TypeScript files and .d typings.

This library is generated from the openapi spec for mailsac which can be seen at https://mailsac.com/openapi.yml or https://mailsac.com/openapi.json.

Usage

npm install @mailsac/api

See the official Mailsac API spec documentation:

https://mailsac.com/docs/api

or the guides:

https://docs.mailsac.com

Example

Get started by instantiating a client library instance with an API key:

import { Mailsac } from "@mailsac/api";
// or for javascript
// const { Mailsac } = require("@mailsac/api");

const mailsac = new Mailsac({ headers: {  "Mailsac-Key": process.env.MAILSAC_KEY } }); // api key from mailsac.com

Then you can use the client to make requests:

// list public messages on a public inbox (no need to create the inbox first!)
const messages = await mailsac.addresses.listMessages('test-public@mailsac.com');
console.log({ messages }); // [{...}, {...}, ...]

// reserve a private address - everybody starts with a free one.
const address = await mailsac.addresses.createAddress('test-private@mailsac.com');
console.log({ address }); // { _id: "test-private@mailsac-com", ... }
const myAddresses = await mailsac.addresses.list();
console.log({ myAddresses }); // [{ _id: "test-private@mailsac-com", ... }]

// got to your email client, send an email to the address....
// ...then check the mail
const messages = await mailsac.addresses.listMessages('test-private@mailsac.com');
console.log({ messages }); // [{...}, {...}, ...]

There are many more API endpoints which are supported by the client library. Look at ./mailsac-client.ts under the Mailsac class to learn more.

Mailsac has features like custom subdomains of msdc.co which require no DNS config, so you can be receiving private email for testing in seconds.