Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ahochsteger/gmail-processor

Gmail Processor is an open-source project that automates the processing of Gmail messages and attachments using Google Apps Script and execute actions (e.g. store attachments in a GDrive folder, log information in a spreadsheet) depending on matching criteria.
https://github.com/ahochsteger/gmail-processor

automation gmail script

Last synced: 5 days ago
JSON representation

Host: GitHub
URL: https://github.com/ahochsteger/gmail-processor
Owner: ahochsteger
License: apache-2.0
Created: 2013-02-10T21:23:01.000Z (about 12 years ago)
Default Branch: main
Last Pushed: 2024-10-29T20:51:09.000Z (3 months ago)
Last Synced: 2024-10-29T22:52:26.977Z (3 months ago)
Topics: automation, gmail, script
Language: TypeScript
Homepage: http://ahochsteger.github.io/gmail-processor/
Size: 19.4 MB
Stars: 487
Watchers: 27
Forks: 135
Open Issues: 10
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

jimsghstars - ahochsteger/gmail-processor - Gmail Processor is an open-source project that automates the processing of Gmail messages and attachments using Google Apps Script and execute actions (e.g. store attachments in a GDrive folder, log i (TypeScript)

README

        # 📧 Gmail Processor 🤖 - Automate Email Processing with Ease

[![GitHub](https://img.shields.io/github/license/ahochsteger/gmail-processor)](#license)

[![GitHub release (with filter)](https://img.shields.io/github/v/release/ahochsteger/gmail-processor)](https://github.com/ahochsteger/gmail-processor/releases)

[![GitHub Release Date - Published_At](https://img.shields.io/github/release-date/ahochsteger/gmail-processor)](https://github.com/ahochsteger/gmail-processor/releases)

[![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/ahochsteger/gmail-processor/ci.yaml)](https://github.com/ahochsteger/gmail-processor/actions/workflows/ci.yaml)

[![Coveralls branch](https://img.shields.io/coverallsCoverage/github/ahochsteger/gmail-processor)](https://coveralls.io/github/ahochsteger/gmail-processor)

More badges ...

[![GitHub tag (with filter)](https://img.shields.io/github/v/tag/ahochsteger/gmail-processor)](https://github.com/ahochsteger/gmail-processor/tags)

[![GitHub Repo stars](https://img.shields.io/github/stars/ahochsteger/gmail-processor)](https://github.com/ahochsteger/gmail-processor/stargazers)

[![GitHub forks](https://img.shields.io/github/forks/ahochsteger/gmail-processor)](https://github.com/ahochsteger/gmail-processor/forks?include=active&page=1&period=2y&sort_by=last_updated)

[![GitHub all releases](https://img.shields.io/github/downloads/ahochsteger/gmail-processor/total)](https://github.com/ahochsteger/gmail-processor/releases)

[![GitHub commit activity (branch)](https://img.shields.io/github/commit-activity/t/ahochsteger/gmail-processor)](https://github.com/ahochsteger/gmail-processor/commits)

![GitHub repo size](https://img.shields.io/github/repo-size/ahochsteger/gmail-processor)

[![GitHub contributors](https://img.shields.io/github/contributors/ahochsteger/gmail-processor)](https://github.com/ahochsteger/gmail-processor/graphs/contributors)

[![All Contributors](https://img.shields.io/badge/all_contributors-12-orange.svg?style=flat-square)](#contributors)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)

[![GitHub issues](https://img.shields.io/github/issues/ahochsteger/gmail-processor)](https://github.com/ahochsteger/gmail-processor/issues)

[![GitHub closed issues](https://img.shields.io/github/issues-closed/ahochsteger/gmail-processor)](https://github.com/ahochsteger/gmail-processor/issues?q=is%3Aissue+is%3Aclosed)

[![GitHub pull requests](https://img.shields.io/github/issues-pr/ahochsteger/gmail-processor)](https://github.com/ahochsteger/gmail-processor/pulls)

[![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/ahochsteger/gmail-processor)](https://github.com/ahochsteger/gmail-processor/pulls?q=is%3Apr+is%3Aclosed)

[![Known Vulnerabilities](https://snyk.io/test/github/ahochsteger/gmail-processor/badge.svg)](https://snyk.io/test/github/ahochsteger/gmail-processor)

[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=ahochsteger_gmail-processor&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=ahochsteger_gmail-processor)

[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=ahochsteger_gmail-processor&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=ahochsteger_gmail-processor)

[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=ahochsteger_gmail-processor&metric=bugs)](https://sonarcloud.io/summary/new_code?id=ahochsteger_gmail-processor)

[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=ahochsteger_gmail-processor&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=ahochsteger_gmail-processor)

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=ahochsteger_gmail-processor&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=ahochsteger_gmail-processor)

[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=ahochsteger_gmail-processor&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=ahochsteger_gmail-processor)

[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=ahochsteger_gmail-processor&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=ahochsteger_gmail-processor)

**[Gmail Processor](https://github.com/ahochsteger/gmail-processor)** is an open-source [Google Apps Script](https://www.google.com/script/start/) 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.

![Dall-e 3 generated image: A friendly smiling robot sitting on a table, busily sorting mails into paper trays, with plants in the picture, colorful flat style, dark background](./docs/static/img/gmail-processor-robot-320.png)

Gmail Processor is the successor of [Gmail2GDrive](https://github.com/ahochsteger/gmail-processor/tree/1.x) with vastly enhanced functionality, completely re-written in [TypeScript](https://www.typescriptlang.org/) 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](https://ahochsteger.github.io/gmail-processor/docs/migrating)).

## Key Features

- 🤖 **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.

- ✂️ **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.

## Getting Started

The **[Getting Started Guide](https://ahochsteger.github.io/gmail-processor/docs/getting-started)** shows how to setup Gmail Processor in Google Apps Script and quickly get it up and running.

## Config Reference

The **[Config Reference](https://ahochsteger.github.io/gmail-processor/docs/reference/)** provides detailed information about the Gmail Processor configuration.

## Examples

The **[Examples](https://ahochsteger.github.io/gmail-processor/docs/examples/)** show different ways of using Gmail Processor.

## Playground

The **[Playground](https://ahochsteger.github.io/gmail-processor/playground)** helps to create the configuration in a schema-aware online editor with a visual schema guide on the side.

## Contributing

Contributions to Gmail Processor are welcome! Whether you want to add new features, fix bugs, or improve documentation, check out the [contribution guidelines](https://ahochsteger.github.io/gmail-processor/docs/community/contributing) to get started.

## Development Guide

See the [Development Guide](https://ahochsteger.github.io/gmail-processor/docs/community/contributing#development-guide) for details.

## Contributors

  

    

      
_{Andreas Hochsteger}
💻 📖 💡 🚇 🚧 👀 🔧 ⚠️

      
_{Piraveen Kamalathas}
💻 📖

      
_{Ciprian Constantinescu}
💻 💡

      
_{marcusschweizer}
💻

      
_{Markus Kurzmann}
💻

      
_{NadavClaudeCohen}
💻 📖 💡

      
_{Schuller Tom}
💻 💡

    

    

      
_{Tom Judge}
💻 💡

      
_{David Lemayian ✨}
📖

      
_{Denny de la Haye}
💻

      
_steve192
💻

      
_{gregory nicholas}
💡

      
_{Gabriel Esposito}
📖

    

  

  

    

      

        

          Add your contributions

        

      

    

  

## License

GmailProcessor is released under the [Apache 2.0 License](LICENSE).

## Support

For any questions, issues, or feedback, please open an [issue](https://github.com/ahochsteger/gmail2gdrive/issues) on GitHub.