open-index/open-npm huggingface dataset:
npm package: @maildrop/api
Description: node-js API for maildrop.cc
Latest version: 1.0.27

# node-js API for maildrop.cc

helper APIs to fetch mail objects from https://maildrop.cc

### install

with [npm](https://www.npmjs.com/package/@maildrop/api) do:

```
npm install --save @maildrop/api
```

### usage

for basic test

```js
const mails = await maildrop.fetchMails("linto@maildrop.cc");
console.log(`${mails.length || "zero"} mails`);

for (const mail of mails)
  console.log(`==========\n${JSON.stringify(mail, null, 2)}\n==========`);
```

##### async fetchMails(email)

fetch mails
@return Object[] like this `{ id, from, to, subject, date, body, html }[]`

| opt   | type                | description                         |
| ----- | ------------------- | ----------------------------------- |
| email | <code>String</code> | [required] sample linto@maildrop.cc |

```json
{
  "id": "HrYSsdRcRA",
  "from": "Linto Cheeran <linto.cet@gmail.com>",
  "to": "linto",
  "subject": "subject",
  "date": "2020-04-08T21:47:13Z",
  "body": "raw email body",
  "html": "html body"
}
```

##### async deleteMail(email, id)

delete individual mail
@return [Object] `{ deleted: true }`

| opt   | type                | description                          |
| ----- | ------------------- | ------------------------------------ |
| email | <code>String</code> | [required] sample linto@maildrop.cc  |
| id    | <code>String</code> | [required] individual mail object id |

```js
for (const mail of mails)
  console.log(await maildrop.deleteMail("linto@maildrop.cc", mail.id));
```

##### async getApiKey(force)

return String `x-api-key`, you can use this in http header

| opt   | type                 | description                     |
| ----- | -------------------- | ------------------------------- |
| force | <code>Boolean</code> | [optional] for forceful refresh |