mailtrap-client
Version:
Mailtrap.io api client with some added features
43 lines (29 loc) • 1.05 kB
Markdown
[](https://travis-ci.org/zuffik/mailtrap-client)
Wrapper around [Mailtrap api](https://mailtrap.docs.apiary.io/) for javascript.
Added polling for messages as _rxjs observer_.
`npm add mailtrap-client`
or
`yarn add mailtrap-client`
Package contains typescript definitions so there is no need to install extra `@types` package.
Example:
```typescript
import {MailtrapClient} from 'mailtrap-client';
// or
// const {MailtrapClient} = require('mailtrap-client');
const client = new MailtrapClient(
'your_api_key'
);
const messages = await client.messages.getMessages(123);
```
Mailtrap client contains almost same structure as mailtrap api described in [docs](https://mailtrap.docs.apiary.io/).
| Valid client properties |
|-------------------------|
| `user` |
| `companies` |
| `inboxes` |
| `sharedInboxes` |
| `messages` |
| `corsDomains` |