Skip to content

mit2u/mailter

Repository files navigation

mailter

mailter is a Python project designed for adding tags in Gmail.

Features

  • Email connectivity and processing (connect.py, gmail.py)
  • Configurable filtering with JSON and Python (filter.json, filter.py)
  • Utility and validation helpers (utils.py, validators.py)
  • Modular constants and functional definitions (constants.py, function_def.py)
  • Data models for custom logic (models.py)
  • Docker support (Dockerfile, README.Docker.md)
  • Container orchestration (compose.yaml)

Getting Started

Prerequisites

  • Python 3.x
  • Docker (optional, for containerized setup)

Installation

git clone https://github.com/mit2u/mailter.git cd mailter pip install -r requirements.txt

Usage

  1. Configuration:

    • Review filter.json for filter setup.
    • Update constants as needed in constants.py.
  2. Run the Application:
    docker build -t mailter . docker-compose up

File Structure

  • connect.py — Email connection logic
  • gmail.py — Gmail interaction
  • filter.py, filter.json — Email filtering
  • function_def.py — Function definitions
  • models.py — Data models
  • constants.py — Constants
  • utils.py — Utility functions
  • validators.py — Validation functions
  • requirements.txt — Pip dependencies
  • Dockerfile — Docker setup
  • compose.yaml — Docker Compose config

About

Updating Mail Tags

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published