https://github.com/fielding/smarterjailmail
Extract data from smartJailMail.com for your prefered consumption
https://github.com/fielding/smarterjailmail
Last synced: about 1 month ago
JSON representation
Extract data from smartJailMail.com for your prefered consumption
- Host: GitHub
- URL: https://github.com/fielding/smarterjailmail
- Owner: fielding
- License: mit
- Created: 2018-04-30T19:56:58.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-03-27T15:09:20.000Z (over 7 years ago)
- Last Synced: 2025-10-10T17:45:19.250Z (10 months ago)
- Language: JavaScript
- Homepage:
- Size: 28.3 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# smarterJailMail
> Extract data from smartJailMail.com for your prefered consumption
## Table of Contents
- [Background](#background)
- [Install](#install)
- [Usage](#usage)
- [API](#api)
- [Contribute](#contribute)
- [License](#license)
## Background
Born out of the desire to scratch my own itch, I started this as a way to
export sent and received message data/content for both archival purposes and
for arbitrary consumption of the data. For example, exporting all messages to
or from your significant other sent via smartJailMail.com, and then importing
those messages in to a custom chat client/system.
### See Also
- [`fielding/TBD`](https://github.com/fielding/TBD)
## Install
```
$ npm install smarterJailMail
```
## Usage
```js
const smarterJailMail = require('smarterJailMail');
smarterJailMail()
.then(data => console.log(JSON.stringify(data, null, 4)));
```
A command-line client is installed under your global npm modules as `fetchSmarterJailMail.js`. Add said global modules path to your environment's
`PATH` for easy shell access.
**TODO(jeff):** Provide one-line info on how to initiate this build step
manually! I *think* it may be `npm add --global`. See `npm help 7 config`.
## API
coming soon...
## Contribute
Contributions are welcome!
## License
[MIT © Fielding Johnston.](../LICENSE)