# Apps.EmailBridgeNLP

**Repository Path**: mirrors_RocketChat/Apps.EmailBridgeNLP

## Basic Information

- **Project Name**: Apps.EmailBridgeNLP
- **Description**: Natural Language Bridge to Legacy Email powered by modern LLMs
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-05
- **Last Updated**: 2026-03-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h1 align="center">Rocket.Chat Email Integration App</h1>

Say goodbye to context switching between your email client and team chat! With **Email Assistant**, managing emails becomes as natural as having a conversation. This powerful Rocket.Chat app transforms your email workflow using AI-powered natural language commands, keeping you in the flow of collaboration.

<div align="center">
    <img width=60% src="https://github.com/user-attachments/assets/ed5799a0-61fe-48fa-bf9f-90dd185464e9">
</div>

<h3 align="center">Integrating Gmail & Outlook with Rocket.Chat</h3>

<p align="center">
  <a href="https://github.com/RocketChat/Apps.EmailBridgeNLP">View Demo</a>
  ·
  <a href="https://github.com/RocketChat/Apps.EmailBridgeNLP/issues">Report Bug</a>
  ·
  <a href="https://github.com/RocketChat/Apps.EmailBridgeNLP/issues">Request Feature</a>
</p>

<div align="center">

[![Contributors](https://img.shields.io/github/contributors/RocketChat/Apps.EmailBridgeNLP.svg?style=for-the-badge)](https://github.com/RocketChat/Apps.EmailBridgeNLP/graphs/contributors)
[![Forks](https://img.shields.io/github/forks/RocketChat/Apps.EmailBridgeNLP.svg?style=for-the-badge)](https://github.com/RocketChat/Apps.EmailBridgeNLP/network/members)
[![Stargazers](https://img.shields.io/github/stars/RocketChat/Apps.EmailBridgeNLP.svg?style=for-the-badge)](https://github.com/RocketChat/Apps.EmailBridgeNLP/stargazers)
[![Issues](https://img.shields.io/github/issues/RocketChat/Apps.EmailBridgeNLP.svg?style=for-the-badge)](https://github.com/RocketChat/Apps.EmailBridgeNLP/issues)
[![License](https://img.shields.io/github/license/RocketChat/Apps.EmailBridgeNLP.svg?style=for-the-badge)](https://github.com/RocketChat/Apps.EmailBridgeNLP/blob/main/LICENSE)

</div>



## 📜 Getting Started

### Prerequisites

-   You need a Rocket.Chat Server Setup
-   Rocket.Chat.Apps CLI,

*   In case you don't have run:
    ```sh
    npm install -g @rocket.chat/apps-cli
    ```

### ⚙️ Installation

-   Every RocketChat Apps runs on RocketChat Server, thus everytime you wanna test you need to deploy the app with this note. lets start setting up:

1. Clone the repo
    ```sh
    git clone https://github.com/<yourusername>/Apps.EmailBridgeNLP
    ```
2. Navigate to the project directory
    ```sh
    cd Apps.EmailBridgeNLP
    ```    
3. Install NPM packages
    ```sh
    npm ci
    ```
4. **Configure API Keys & Authentication** (Administrators)
    📖 **See [AUTH_&_LLM_SETUP.md](AUTH_&_LLM_SETUP.md) for detailed setup instructions** on how to obtain:
    - Gmail/Google OAuth credentials
    - Outlook/Microsoft OAuth credentials  
    - OpenAI, Gemini, Groq, or self-hosted LLM API keys

5. Deploy app using:

    ```sh
    rc-apps deploy --url <server_url> --username <username> --password <password>
    ```
      Where:
    - `<server_url>` is the URL of your Rocket.Chat workspace.
    - `<username>` is your username.
    - `<password>` is your password.

<h2>Usage 💬</h2>

👋 Need some help with your /email?

- **`/email help`**: Show this help message  
- **`/email login`**: Login to your email account  
- **`/email logout`**: Logout from your email account  
- **`/email config`**: Open user preferences and settings  
- **`/email report`**: Get daily email statistics report

Natural Language command exmples:

- **`/email summarize this thread/channel and send it as email to boss@rc.com who refuses to use chat`**: summarize thread/channel and send as email to specified recipient(s) 
- **`/email post in the channel for everyone the budget for 2025 email pdf received between 5/1/2025 and 6/24/2025`**: searchs the emails, extracts the attachment and upload it in channel. 
- **`/email please give me report for yesterday`**: Get daily email statistics report

### User Preferences Modal:
User can go to User Preferences by entering `/email config` or by clicking "User Preferences" button in helper message. User can config email provider, language, categories to keep in report , adding new categories etc in it.


<h2>Development & Debugging 🐛</h2>

### Local Development
```bash
# Deploy with hot reload for development
rc-apps deploy --url http://localhost:3000 -u <username> -p <password> --update
```

### Troubleshooting
- Check logs in Rocket.Chat Administration > View Logs  
- Set app log level to "Debug" in Administration > Apps > EmailBridgeNLP > Settings

### Prerequisites
- Node.js (v14+)
- npm (v6+)

<h2>🧑‍💻 Contributing</h2>

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.

Don't forget to give the project a star! Thanks again!

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

<h2>License 📄</h2>

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

<h2>Support 💬</h2>

If you encounter any issues or have questions:
- Open an issue on GitHub
- Check the [Rocket.Chat documentation](https://docs.rocket.chat/)
- Join the Rocket.Chat community discussions