# mboxtract

> Extracts all attachments from large MBOX files

Latest version **1.0.2** (published 2024-12-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install mboxtract
pnpm add mboxtract
yarn add mboxtract
bun add mboxtract
```

Provides the command `mboxtract`.

## Health

**Score 25/100 (F)** — status: maintenance-mode.

Positive: no vulnerabilities.

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

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2024-12-09 |
| First published | 2017-06-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 6.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 24 |
| Author | ricksbrown73@gmail.com |
| Maintainers | ricksbrown |

## Links

- npm: https://www.npmjs.com/package/mboxtract
- Repository: https://github.com/ricksbrown/mboxtract
- Homepage: https://github.com/ricksbrown/mboxtract#readme
- Issues: https://github.com/ricksbrown/mboxtract/issues
- npm.io page: https://npm.io/package/mboxtract

## Dependencies (3)

- [minimist](https://npm.io/package/minimist.md) ^1.2.8
- [node-mbox](https://npm.io/package/node-mbox.md) 1.0.0
- [mailparser](https://npm.io/package/mailparser.md) ^3.7.2

## Recent versions

- 1.0.2 (latest) — 2024-12-09
- 1.0.1 — 2017-07-17
- 1.0.0 — 2017-06-12

## README

# mboxtract
Extract attachments from (tremendously huge) mbox files.

Places all the attachments in a directory.

Use `subdirs` to put all attachments into a subdirectory based on the date of the mail they are extracted from. 

This was originally created to process an 80.6GB file extracted from GMail.

# Usage
## Command Line
```
npm install -g mboxtract
mboxtract --subdirs -o attachments mymbox.mbox
```

## NodeJS
```
var mboxtract = require("mboxtract");
mboxtract.extract({
	outputDir: "attachments",
	subDirs: true,
	mboxFile: "mymbox.mbox"
});
```

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