npm

Need private packages and team management tools?Check out npm Orgs. »

mailslurp-client

6.7.0 • Public • Published

MailSlurp is an Email API for developers and QA testers. It let's users create emails addresses on demand, then send and receive emails and attachments in applications and tests. MailSlurp is free for personal use.

Features ✉️ → 📭 → 📨

  • Create dynamic email accounts
  • Receive emails with waitFor(condition) long-polling
  • Receive emails using Push WebHooks
  • Send templated, transactional emails

About

This project contains the official and recommend MailSlurp SDK Client for Node, Javascript, and Typescript. All MailSlurp requests require API Authentication. Obtain a free API Key for personal use.

Getting Started

Resources
📦 NPM Module
📖 Documentation
✍️ Examples
🎓 Developer Portal
🔑 Get API Key
⚠️ Report an issue

Examples

npm install --save mailslurp-client
// instantiate client
const MailSlurp = require('mailslurp-client').default;
const mailslurp = new MailSlurp({ apiKey: 'XXXXX' });
 
// create a new email address
const { emailAddress, id } = await mailslurp.createInbox();
 
// receive email using created inbox
const { subject, body } = await mailslurp.waitForLatestEmail(id);
 
// send email from inbox
await mailslurp.sendEmail(id, { to: ['xxxx@gmail.com'] })

See documentation for all methods.

Other Clients

You can find more MailSlurp SDKs on our website. If you wish to call the REST API directly please see the HTTP Documentation.

Change Log

See CHANGELOG.md.

Issues

Please open an issue.

License

MIT

install

npm i mailslurp-client

Downloadsweekly downloads

1,618

version

6.7.0

license

MIT

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability