# mbox-attachment-extract

> Node.js cli tool to extract attachments from .mbox files

Latest version **1.1.2** (published 2020-02-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install mbox-attachment-extract
pnpm add mbox-attachment-extract
yarn add mbox-attachment-extract
bun add mbox-attachment-extract
```

Provides the command `mbox-attachment-extract`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2020-02-17 |
| First published | 2019-08-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 8.4 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | André L. Adriano |
| Maintainers | andre000 |
| Keywords | mbox |

## Links

- npm: https://www.npmjs.com/package/mbox-attachment-extract
- Repository: https://github.com/andre000/mbox-attachment-extract
- Homepage: https://github.com/andre000/mbox-attachment-extract#readme
- Issues: https://github.com/andre000/mbox-attachment-extract/issues
- npm.io page: https://npm.io/package/mbox-attachment-extract

## Dependencies (8)

- [ora](https://npm.io/package/ora.md) ^4.0.3
- [meow](https://npm.io/package/meow.md) ^6.0.1
- [chalk](https://npm.io/package/chalk.md) ^3.0.0
- [p-event](https://npm.io/package/p-event.md) ^4.1.0
- [node-mbox](https://npm.io/package/node-mbox.md) ^1.0.0
- [mailparser](https://npm.io/package/mailparser.md) ^2.7.7
- [update-notifier](https://npm.io/package/update-notifier.md) ^4.1.0
- [sanitize-filename](https://npm.io/package/sanitize-filename.md) ^1.6.3

## Recent versions

- 1.1.2 (latest) — 2020-02-17
- 1.1.1 — 2019-08-27
- 1.1.0 — 2019-08-13
- 1.0.8 — 2019-08-13
- 1.0.7 — 2019-08-12
- 1.0.6 — 2019-08-12
- 1.0.5 — 2019-08-12
- 1.0.4 — 2019-08-12
- 1.0.3 — 2019-08-12

## README

# mbox-attachment-extract
[![buddy pipeline](https://app.buddy.works/dev-next/mbox-attachment-extract/pipelines/pipeline/204178/badge.svg?token=97bf4dcd17a1b58262a8a015c9528b9846ee0998e240f0de9322008e604b7df7 "buddy pipeline")](https://app.buddy.works/dev-next/mbox-attachment-extract/pipelines/pipeline/204178)
[![CodeFactor](https://www.codefactor.io/repository/github/andre000/mbox-attachment-extract/badge)](https://www.codefactor.io/repository/github/andre000/mbox-attachment-extract)
[![david-dm](https://david-dm.org/andre000/mbox-attachment-extract.svg)](https://github.com/andre000/mbox-attachment-extract/network/dependencies)

This is a cli tool to extract attachments from .mbox files.

![printscreen](https://i.imgur.com/qC0jtQn.png)

## Installation

Install with npm: `npm i mbox-attachment-extract -g`

## Usage

The command:

`mbox-attachment-extract <<path-to-mbox-file>> <<path-to-extracted-files>>`

Parameters:

`--pattern, -p` Regex to filter attachments. Default: ''

`--filenameAsSubject, -s` Create the attachment with the subject as the filename. Example: fromdomain_subject.zip

`--help` Show the help message

## Demo

![demo](https://github.com/andre000/mbox-attachment-extract/raw/master/demo.svg?sanitize=true)

## Tests

Run the command: `npm t`

## Packages

- [chalk](https://github.com/chalk/chalk)
- [meow](https://github.com/sindresorhus/meow)
- [ora](https://github.com/sindresorhus/ora)
- [node-mbox](https://github.com/robertklep/node-mbox)
- [mailparser](https://github.com/nodemailer/mailparser)

---
_Source: https://npm.io/package/mbox-attachment-extract · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._