Skip to content

glblackburn/AutoSkipInbox

Repository files navigation

Getting Started

Overview

AutoSkipInbox is a Gmail automation tool that helps manage your inbox by automatically processing emails based on labels. The tool can archive emails that aren't explicitly marked to stay in the inbox, and can create Gmail filters to automate future email handling.

The project provides both Ruby and Python implementations, allowing you to choose the language that best fits your environment. Both implementations provide the same core functionality:

  • Process inbox emails and archive those not marked to stay
  • Create Gmail filters based on email addresses
  • Generate reports on email labels and senders
  • Manage email labels and filters

Release Notes

Version 2.0.0 - Python Implementation (2025-12-01)

  • 🐍 New: Complete Python implementation added alongside Ruby
  • 📁 New: Project reorganized into python/ and ruby/ directories
  • 🔒 Security: Credentials moved to ~/.secure/AutoSkipInbox/ for Python version
  • 🛠️ New: Python Makefile with pyenv support
  • 📚 New: Comprehensive Python documentation

For detailed release notes, see RELEASE_NOTES.md.

Previous Releases

  • Version 1.0.0: Initial Ruby release with Gmail API integration

Installation

This project provides both Ruby and Python implementations. Choose the one that best fits your needs.

Ruby Implementation

For Ruby installation and usage instructions, see ruby/README.md.

Quick start:

cd ruby
./install.sh

Python Implementation

For Python installation and usage instructions, see python/README.md.

Quick start:

cd python
make setup

TODO

  • figure out how to do google auth as part of install. there is a step past saving the client_secret.json file that prompts as part of the auth.
  • add overview
  • document how to used once installed
  • update installer to validate ruby version
  • DONE: document shell and ruby scripts
  • DONE: update installer to install ruby gems

Scripts

Ruby Scripts

For detailed information about Ruby scripts, see ruby/README.md.

  • autoskipinbox.rb: Processes emails in the Inbox. Any email that is not marked as "keep-inbox" or "autoskipinbox/tofix" will be archived and the "autoskipinbox" label will be applied.
  • get-tofix-from.rb: Processes emails with the label "autoskipinbox/tofix" and creates filters to keep future emails from those addresses in the inbox.
  • get-todump-from.rb: Processes emails with the label "autoskipinbox/todump" and creates filters to dump future emails from those addresses.
  • get-filters.rb: Lists all Gmail filters.
  • get-label-report.rb: Pulls counts of unique from addresses with each label used.
  • run-it.sh: Wrapper script that calls autoskipinbox.rb, get-tofix-from.rb, get-todump-from.rb, and get-filters.rb. Captures output into timestamped logs and processes summary statistics.

Python Scripts

For detailed information about Python scripts, see python/README.md.

  • autoskipinbox.py: Main inbox processing script
  • get_tofix_from.py: Process tofix emails and create keep-inbox filters
  • get_todump_from.py: Process todump emails and create dump filters
  • get_filters.py: List all Gmail filters
  • get_label_report.py: Generate label statistics report
  • run-it.sh: Wrapper script that calls autoskipinbox.py, get_tofix_from.py, get_todump_from.py, and get_filters.py. Captures output into timestamped logs and processes summary statistics.

References

Gmail API

Ruby

Python

About

Ruby scripts to keep your GMail inbox clean. Email just Auto Skips your Inbox.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors