A custom Gmail spam filter bot.

Clone this repo:
  1. 78e34aa update generation by Jess Frazelle · 6 weeks ago master
  2. def40d8 Bump version to v0.0.5 by Jess Frazelle · 11 months ago v0.0.5
  3. fae9127 update by Jess Frazelle · 11 months ago
  4. ef00d93 update by Jess Frazelle · 11 months ago
  5. 5fc14e5 update by Jess Frazelle · 11 months ago

1up

make-all make-image GoDoc Github All Releases

A custom Gmail spam filter bot.

Table of Contents

How it works

The bot will create 3 labels in your Gmail:

  • 1up/good: where you label emails that are "good"
  • 1up/bad: where you label emails that are "bad"
  • 1up/quarantine: where the bot will place emails that it thinks are "bad" based off the results of the Bayes classifier

Thanks to @brendandburns for pointing me at Bayes classifiers.

Installation

Binaries

For installation instructions from binaries please visit the Releases Page.

You will want to follow the steps here to turn on the Gmail API and get a credentials file.

Via Go

$ go get github.com/genuinetools/1up

Via Docker

$ docker run --rm -it -v ~/configs/1up:/1up:ro \
    --tmpfs /tmp \
    r.j3ss.co/1up -f /1up/credentials.json

Usage

$ 1up -h
1up -  A custom Gmail spam filter bot.

Usage: 1up <command>

Flags:

  -d, --debug       enable debug logging (default: false)
  -f, --creds-file  Gmail credential file (or env var GMAIL_CREDENTIAL_FILE) (default: <none>)
  -i, --interval    update interval (ex. 5ms, 10s, 1m, 3h) (default: 5m0s)
  --once            run once and exit, do not run as a daemon (default: false)

Commands:

  version  Show the version information.