Skip to main content
Glama
README.md
# šŸ“§ MailPilot-AI

> AI-powered Gmail Assistant built using **FastMCP** and the **Gmail API**.

MailPilot-AI is an intelligent Gmail assistant that connects with Gmail using OAuth2 authentication and provides AI-powered email management features such as reading, searching, sending, replying, summarizing, and organizing emails.

---

## ✨ Features

- šŸ“„ Read latest emails
- šŸ“¬ Read unread emails
- šŸ” Search emails
- šŸ“– Open complete email
- šŸ“¤ Send emails
- šŸ’¬ Reply to emails
- ⭐ Star emails
- šŸ“¦ Archive emails
- šŸ—‘ Delete emails
- āœ” Mark emails as read
- šŸ¤– AI Inbox Summary
- 🧠 Smart email workflows
- šŸ” Secure Gmail OAuth authentication

---

## šŸ— Project Structure

```text
MailPilot-AI/
│
ā”œā”€ā”€ agent/
│   ā”œā”€ā”€ email_service.py
│   ā”œā”€ā”€ inbox_summary.py
│   ā”œā”€ā”€ memory.py
│   ā”œā”€ā”€ planner.py
│   ā”œā”€ā”€ reply_generator.py
│   └── workflows.py
│
ā”œā”€ā”€ gmail/
│   ā”œā”€ā”€ actions.py
│   ā”œā”€ā”€ attachments.py
│   ā”œā”€ā”€ compose.py
│   ā”œā”€ā”€ reader.py
│   └── search.py
│
ā”œā”€ā”€ docs/
ā”œā”€ā”€ tests/
│
ā”œā”€ā”€ auth.py
ā”œā”€ā”€ gmail_api.py
ā”œā”€ā”€ server.py
ā”œā”€ā”€ requirements.txt
└── README.md
```

---

## šŸ›  Tech Stack

- Python
- FastMCP
- Gmail API
- OAuth 2.0
- Google Cloud Platform
- Git
- GitHub

---

## šŸš€ Getting Started

### Clone the repository

```bash
git clone https://github.com/himateja1/MailPilot-AI.git
```

### Go into the project

```bash
cd MailPilot-AI
```

### Create a virtual environment

```bash
python -m venv .venv
```

### Activate the virtual environment

Windows

```bash
.venv\Scripts\activate
```

Linux / macOS

```bash
source .venv/bin/activate
```

### Install dependencies

```bash
pip install -r requirements.txt
```

### Configure Gmail API

1. Create a Google Cloud Project.
2. Enable the Gmail API.
3. Download `credentials.json`.
4. Place `credentials.json` in the project root.
5. Run authentication once.

---

## ā–¶ Running the Project

```bash
python server.py
```

---

## šŸ“ø Screenshots

### Inbox Summary

_Add screenshot here_

---

### Reading Emails

_Add screenshot here_

---

### Sending Emails

_Add screenshot here_

---

### MCP Server

_Add screenshot here_

---

## šŸ“Œ Future Improvements

- šŸŽ¤ Voice commands
- šŸ“… Google Calendar integration
- šŸ“Ž Attachment summarization
- 🌐 Web dashboard
- šŸ¤– Multi-agent support
- 🧠 RAG over emails
- šŸ“± Mobile companion

---

## šŸ¤ Contributing

Contributions, ideas, and suggestions are welcome.

Feel free to fork the repository and submit a pull request.

---

## šŸ“„ License

This project is for educational and portfolio purposes.

---

## šŸ‘Øā€šŸ’» Author

**Himateja**

GitHub: https://github.com/himateja1