README.md

fwd_outlook_graph

AKA FOG
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This project is a hobby project of mine to use the Microsoft Graph API to forward emails from an Outlook account to any number of other email accounts automatically when you receive an email.

(back to top)

Built With

• 
• 

(back to top)

Getting Started

Prerequisites

• Python 3

Installation

1. Setup an Azure App
2. Clone the repo

   git clone https://github.com/blaine-t/fwd_outlook_graph.git
   cd fwd_outlook_graph

3. Setup venv

   python3 -m venv .venv
   source .venv/bin/activate
   python3 -m pip install -r requirements.txt

4. Configure config.py to your needs

   cd fwd_outlook_graph
   cp config.example.py config.py
   nano config.py

5. Run the app

• Development

  python3 main.py

• Production

  gunicorn main:app -b 127.0.0.1:5000 --threads 2

You need at least 2 threads for Gunicorn if you are going to use the admin panel. Although leaving admin panel enabled in production is not recommended

(back to top)

Usage

Forward emails automatically with extra features like:

• Catch-all email addresses
• Add or don't to Sent box
• Multiple forwarding addresses

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Get access token from Graph (Microsoft Graph API)
• Forward messages with Graph
• Read messages from Graph
• Send messages with Graph
• Cache access token
• Increase security with clientState
• Add subscriptions
  • lifeCycle support
• Development tool routes
• Development tool page
  • Style Development tool page
  • Development tool proper favicon support
• Move to pure python config
• Encrypt cache when possible
• Improve catch all for more readable emails
• Write documentation
• Improve error handling
• Missed Delta support (If someone can get this POST let me know because I can't develop for it since I can't get it)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

(back to top)

Contact

Blaine Traudt - blaine-t - blaine-t@bathost.net

Project Link: https://github.com/blaine-t/fwd_outlook_graph

(back to top)

Acknowledgments

• Microsoft Graph Documentation
• Flask Documentation
• darrenjrobinson's example

(back to top)