Skip to content
bzgPublic

About

Backlog Of Notable Emails

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

BONE — Backlog Of Notable Emails

8==8      <= A bone.

https://img.shields.io/badge/status-active-brightgreen.svg?style=for-the-badge https://img.shields.io/badge/versioning-intver.org-blue.svg?style=for-the-badge

BONE is an email-driven report tracker – see the principles.

BONE monitors IMAP mailboxes and Maildirs, classifies incoming emails into sources by header matching, detects report types from subject tags, applies commands from email bodies, and manages roles per source.

BONE reports can be read with other tools:

The gnus-gnaw, notmuch-gnaw and mu4e-gnaw front-ends are unmaintained proofs of concept.

BONE manual

For more extensive documentation, read the BONE manual.

For the codebase, architecture and development setup, see CONTRIBUTING.md.

bone-capture.jpg

Quick start

# 1. Copy and edit the config (minimal: one mailbox, one source)
cp config.edn.minimal config.edn
bb test-config              # validate it

# 2a. Run once (fetch new emails, expire, exit)
clj -M:run

# 2b. Run in watch mode (IMAP IDLE or Maildir, stays running)
clj -M:run -- --watch

# 2c. Or build an uberjar and run it (production)
bb build-jar                # produces target/bone.jar + bin/bone wrapper
bin/bone --watch

# 3. Export reports to public/
bb export                   # incremental (skips if nothing changed)
bb export --force           # full rebuild, ignore timestamps

# 4. Send notification emails
bb notify --dry-run         # preview without sending
bb notify

# 5. Run tests
clj -M:test

Configuration

BONE reads ./config.edn (override with -c <path> or BONE_CONFIG). Its two required sections are :mailboxes (where the mail comes from: IMAP or Maildir) and :sources (which mail belongs to which tracker: matched by List-Id, alias or delivery address).

  • config.edn.minimal is the smallest working config.
  • config.edn.example is the annotated reference of every key.
  • The manual’s Deploying BONE chapter documents each section: mailboxes, sources, periods, expiry, notifications, theme, logging, production setup.
  • Its CLI reference lists every bb task and flag.

Contributing

See CONTRIBUTING.md for reporting bugs, sending patches, and working on the codebase.

You can also send me an email and support my work on liberapay.

Intentional Versioning

This project uses Intentional Versioning. The three audiences:

  • Users : end-users and sysadmins who operate BONE instances
  • Integrators : consumers of the exported JSON/RSS/Org formats
  • Maintainers : maintainers of the codebase

Support the Clojure(script) ecosystem

If you like Clojure(script), consider supporting maintainers by donating to clojuriststogether.org.

License

Copyright © 2026 Bastien Guerry

The Clojure code is distributed under the Eclipse Public License 2.0 and the JavaScript code under the Mozilla Public License 2.0.

About

Backlog Of Notable Emails

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Used by

Contributors

Languages