https://github.com/badsyntax/mailinabox-api-ts

JavaScript/TypeScript client SDK for the Mail-in-a-Box API.
https://github.com/badsyntax/mailinabox-api-ts

fetch mail-in-a-box mailinabox typescript

Last synced: 3 months ago
JSON representation

JavaScript/TypeScript client SDK for the Mail-in-a-Box API.

• Host: GitHub
• URL: https://github.com/badsyntax/mailinabox-api-ts
• Owner: badsyntax
• Created: 2020-08-04T12:10:40.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-12-20T12:41:35.000Z (over 4 years ago)
• Last Synced: 2025-03-17T14:22:05.696Z (3 months ago)
• Topics: fetch, mail-in-a-box, mailinabox, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/mailinabox-api
• Size: 77.1 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## mailinabox-api

[![Build & Publish](https://github.com/badsyntax/mailinabox-api/workflows/Build%20&%20Publish/badge.svg)](https://github.com/badsyntax/mailinabox-api/actions?query=workflow%3A%22Build+%26+Publish%22)

JavaScript/TypeScript client SDK for the Mail-in-a-Box API.

- API version: 0.51.0

- Package version: 0.51.1

https://www.npmjs.com/package/mailinabox-api

**NOTE:** This package is [auto-generated](https://github.com/badsyntax/mailinabox-api) from the Mail-In-A-Box OpenAPI spec.

### Installing

```bash

npm install mailinabox-api --save

```

### Usage

```ts

import {

  Configuration,

  ConfigurationParameters,

  MailUsersResponseFormat,

  MailApi

} from 'mailinabox-api';

const apiConfigParams: ConfigurationParameters = {

  basePath: '/admin',

  username: 'YOUR_USERNAME',

  password: 'YOUR_PASSWORD'

};

const apiConfig = new Configuration(apiConfigParams);

const mailApi = new MailApi(apiConfig);

// example request

const users = await mailApi.getMailUsers({

  format: MailUsersResponseFormat.Json,

});

```

## License

MIT License

Copyright (c) 2020 Richard Willis