More badges ...
Gmail Processor is an open-source Google Apps Script library that automates the processing of Gmail messages and attachments by executing actions (e.g. store attachments in a GDrive folder, log information into a spreadsheet) depending on powerful matching criteria.
Gmail Processor is the successor of Gmail2GDrive with vastly enhanced functionality, completely re-written in TypeScript with extensibility and stability in mind, using a modern development setup and automation all over the place (dependency updates, tests, documentation, releases, deployments). There's a convenient migration available to convert your old configuration to the new format (see Migrating from GMail2GDrive).
- 🤖 Extensive Automation: Automate email processing using the provided configuration to match threads, messages, and attachments, and trigger actions accordingly.
- 📁 Google Drive Integration: Store files such as attachments, PDFs of messages, or entire threads into any location within Google Drive, providing easy organization and accessibility.
- 🔒 PDF Decryption: Decrypt password-protected PDFs attached to emails and store them.
- ✂️ OCR Text Extraction: Extract text (e.g. invoice number) from attached documents (JPEG, PNG, GIF, PDF) to organize and annotate your attachments.
- 📄 Google Spreadsheet Logging: Keep track of processed threads, messages, and attachments by logging valuable information into a Google Spreadsheet.
- 🔧 Flexible Configuration: Gmail Processor operates based on a JSON configuration that allows you to define matching rules and specify corresponding actions to be executed.
- 📐 Extensible Architecture: Designed with extensibility in mind, Gmail Processor enables seamless addition of new actions and integrations in the future to adapt to evolving requirements.
The Getting Started Guide shows how to setup Gmail Processor in Google Apps Script and quickly get it up and running.
The Config Reference provides detailed information about the Gmail Processor configuration.
The Examples show different ways of using Gmail Processor.
The Playground helps to create the configuration in a schema-aware online editor with a visual schema guide on the side.
Contributions to Gmail Processor are welcome! Whether you want to add new features, fix bugs, or improve documentation, check out the contribution guidelines to get started.
See the Development Guide for details.
Gmail Processor uses a set of automated tools and bots to ensure high code quality, security, and smooth maintenance:
- 🤖 Renovate: Automatically keeps dependencies up to date via Pull Requests.
- 🛡️ Snyk: Scans for vulnerabilities in dependencies and Infrastructure as Code (IaC).
- 🧩 SonarSource: Performs static code analysis to detect bugs, vulnerabilities, and code smells.
- 💎 Gemini Code Assist: Provides AI-powered code reviews and assistance for contributors.
- 🚀 GitHub Actions: Heavily used for Continuous Integration (CI), testing, and automated deployment.
- ✨ AllContributors: Manages the list of contributors via a GitHub bot.
GmailProcessor is released under the Apache 2.0 License.
For any questions, issues, or feedback, please open an issue on GitHub.