Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AnalogJ/hatchet
Cut down spam in your Gmail Inbox
https://github.com/AnalogJ/hatchet
Last synced: about 2 months ago
JSON representation
Cut down spam in your Gmail Inbox
- Host: GitHub
- URL: https://github.com/AnalogJ/hatchet
- Owner: AnalogJ
- License: mit
- Created: 2021-07-06T17:15:10.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-13T14:22:01.000Z (9 months ago)
- Last Synced: 2024-07-05T06:12:17.790Z (3 months ago)
- Language: Go
- Size: 12.8 MB
- Stars: 363
- Watchers: 8
- Forks: 12
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hatchet
Cut down spam in your Gmail Inbox
# Introduction
Hatchet is a tool to help you manage/prune your Email Inbox.
As it processes your inbox, it will keep track the unique sender email addresses and the number of emails from each sender.
It will also search the email headers and body for "unsubscribe" links.
Once Hatchet finishes its work, it will generate a spreadsheet that you can use to quickly unsubscribe from the most annoying mailing lists spamming your inbox.
# Getting Started
## Windows/Mac/Linux Binaries
You can download the latest version of hatchet by visting the following url: https://github.com/analogj/hatchet/releases
Download the relevant binary, then run it:
```bash
# windows
hatchet-windows-amd64.exe report \
--imap-hostname=imap.gmail.com \
[email protected] \
--imap-password=xxxxxxx
# macos
hatchet-darwin-amd64 report \
--imap-hostname=imap.gmail.com \
[email protected] \
--imap-password=xxxxxxx
# linux
hatchet-linux-amd64 report \
--imap-hostname=imap.gmail.com \
[email protected] \
--imap-password=xxxxxxx
```
## Run via Docker
```bash
docker run --rm -v `pwd`:/out/ \
ghcr.io/analogj/hatchet:latest report \
--output-path="/out/sender_report.csv" \
--imap-hostname=imap.gmail.com \
[email protected] \
--imap-password=xxxxxxx
```
## Run from Source
```bash
go run cmd/hatchet/hatchet.go report \
--imap-hostname=imap.gmail.com \
[email protected] \
--imap-password=xxxxxxx
```
# Google Account Authentication & App Passwords
> If an app or site doesn’t meet Google's security standards, Google might block anyone who’s trying to sign in to your
> account from it. Less secure apps can make it easier for hackers to get in to your account, so blocking sign-ins from
> these apps helps keep your account safe.
>
> [Less secure apps & your Google Account](https://support.google.com/accounts/answer/6010255?hl=en#zippy=%2Cif-less-secure-app-access-is-on-for-your-account%2Cif-less-secure-app-access-is-off-for-your-account%2Cuse-an-app-password)
By default Google will block third party applications from accessing your Gmail account via username + password.
To use `hatchet` with your Gmail account, you'll need to authenticate to your account by doing one of the following
## Option 1: Enable "Less secure app" access
- Go to the [Less secure app access](https://myaccount.google.com/lesssecureapps) section of your Google Account. You might need to sign in.
- Turn **Allow less secure apps** on.
## Option 2: Create an App Password (required for 2FA protected accounts)
If you use [2-Step-Verification](https://support.google.com/accounts/answer/185839) and get a "password incorrect" error when you sign in, you can try to use an App Password.
> An App Password is a 16-digit passcode that gives a less secure app or device permission to access your Google Account. App Passwords can only be used with accounts that have 2-Step Verification turned on.
>
> https://support.google.com/accounts/answer/185833
- Go to your [Google Account Settings Page](https://myaccount.google.com/).
- Select Security.
- Under "Signing in to Google," select **App Passwords**. You may need to sign in. If you don’t have this option, it might be because:
- 2-Step Verification is not set up for your account.
- 2-Step Verification is only set up for security keys.
- Your account is through work, school, or other organization.
- You turned on Advanced Protection.
- At the bottom, choose **Select app** and choose **Mail** and then **Select device** and choose **Other**, type in "hatchet" and then Generate.
- The App Password is the 16-character code in the yellow bar. Copy this text, store it securely in a password manager or similar.
- Tap Done.
## Use your credentials with hatchet
Now that you have the correct credentials to authenticate to your Gmail account with Hatchet, you can run the tool locally.
```
hatchet report \
--imap-hostname=imap.gmail.com \
[email protected] \
--imap-password=[gmail account password OR app password]
```
# Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
# Authors
Jason Kulatunga - Initial Development - @AnalogJ
# License
- MIT
- [Logo: Hatchet by Fran Couto from NounProject.com](https://thenounproject.com/icon/hatchet-3263047/)