Skip to content

Latest commit

 

History

History
27 lines (21 loc) · 1.85 KB

README.md

File metadata and controls

27 lines (21 loc) · 1.85 KB

email-rules

email-rules is a repository to build Email Rules and Filters to help you organize your inbox. Documentation for the repository can be found here.

Table of Contents:

Purpose:

Rather than using the clunky UIs of multiple different email clients, email-rules enables you to write your rules/filters using Python and then generate client-compatible representations of your rules, so they can be enforced. This repository enables you to have a single source for all of your rules, and allows you to generate rules in a streamlined manner. Additionally, if you decide to switch email clients in the future, you will be able to copy over (or regenerate) all of your email rules without having to manually (and painstakingly) rewrite them for each email client you use.

Documentation:

Documentation outlining how to use this repository can be found here. I used the NumPy Documentation Standard to outline the functionality of my code, and used sphinx to generate the docs website.

Currently Supported Email Clients:

  • Gmail

While Gmail is the only supported email client right now, this will change in the future. See Email Clients to be Supported in the Future for more details.

Email Clients to be Supported in the Future:

  • Microsoft Outlook
  • Mac Mail