Welcome to the AI Outlook Add-in, a powerful tool that integrates Groq AI and Sambanova AI capabilities into Microsoft Outlook web, enhancing your email experience. This project aims to provide users with AI-powered assistance in their daily email interactions, making email management more efficient and productive.
If you appreciate my work, please consider giving it a star! 🤩
Give us a star if you like the project. We are looking for contributors to help us improve the project. If you are interested, please check the Contributing section.
The AI Outlook Add-in enhances your email workflow by providing AI-powered assistance directly within your Outlook web interface. By leveraging the OpenAI v1 API, this add-in offers intelligent features to help you compose, analyze, and manage your emails more efficiently.
Project Repository: https://github.com/sctg-development/ai-outlook
Deployed Add-in: https://outlook.addin.pp.ua/ Deployed Add-in (GitHub Pages): https://sctg-development.github.io/ai-outlook
- AI-powered email composition suggestions
- Automated email summarization
- Prompt easy configurable in src/config.ts
- Model configuration in src/config.ts
- Language translation integration
- Compatible with Groq AI and Sambanova AI (via AI-Proxy-Cloudflare due to CORS)
Before you can use the AI Outlook Add-in, you'll need:
- Access to your company's Microsoft 365 admin console
- A Groq AI developer API key (obtain one from Groq's developer portal)
- For SambaNova AI, obtain an API key from SambaNova's developer portal you also need a proxy for bypassing the lack of CORS headers in the sambanova API. You can use our AI-Proxy-Cloudflare for this purpose.
To install the AI Outlook Add-in, follow these steps:
- Download the latest release (nightly) ZIP file from the project's GitHub releases section.
- Note release_*.zip use Cloudflare Pages for hosting the add-in.
- Note release_github_pages_*.zip use GitHub Pages for hosting the add-in.
- Log in to your company's Microsoft 365 admin console.
- Navigate to Settings > Integrated applications.
- Click on "Load customized applications" (or a similar option for adding custom add-ins).
- Upload the ZIP file you downloaded in step 1.
- Follow any additional prompts to complete the installation process.
Note: The exact steps may vary slightly depending on your organization's Microsoft 365 configuration. If you encounter any issues, please contact your IT administrator for assistance.
To install the AI Outlook Add-in on Outlook web if you cannot use a zip or xml file, follow these steps:
- Open Outlook on the web and sign in to your account.
- Download the latest manifest.xml or build yours.
- Navigate to Settings > Integrated applications.
- Click on "Load customized applications" (or a similar option for adding custom add-ins).
- Upload the XML file you downloaded in step 2.
- Follow any additional prompts to complete the installation process.
Note: The icon may not appear in the ribbon immediately after installation. If you don't see it, try refreshing the page or restarting your browser.
After installation:
- Open Outlook on the web and sign in to your account.
- Open an email or start composing a new message.
- Look for the AI Outlook Add-in called AI emailer icon in the Outlook ribbon.
- Click on the icon to open the add-in pane.
- Enter your Groq AI developer API key when prompted (this is a one-time setup).
- Use the add-in features as needed in your email workflow:
- For composition assistance, select the text you want to improve and use the relevant feature.
- For email summarization, open the email you want to summarize and use the summarization feature.
- For translation, select the text to translate and choose the target language.
Refer to the in-app instructions for more detailed usage guidelines.
To set up the development environment:
- Clone the repository:
git clone https://github.com/sctg-development/groq-outlook.git
- Install dependencies:
npm install
- Sign in Office 365:
npm run signin
- Start the development server:
npm start
You can customize the AI Outlook Add-in by modifying the src/config.ts
file.
You'll also need to update the manifest.json
file to reflect your deployment settings.
This project is licensed under the GNU Affero General Public License v3.0 (AGPLv3). For more details, see the LICENSE file in the project repository.
Please refer to the PRIVACY.md file for information on data collection, usage, and privacy practices related to the Groq Outlook Add-in.
We welcome contributions to the AI Outlook Add-in! If you'd like to contribute, please follow these steps:
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature
) - Commit your changes (
git commit -m 'Add some AmazingFeature'
) - Push to the branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
If you encounter any issues or have questions about the AI Outlook Add-in, please open an issue on our GitHub repository.
This project is not affiliated with or endorsed by Microsoft, Meta, SambaNova or Groq. It is an independent add-in developed to enhance the Outlook web experience using Groq's AI capabilities and Meta Llama models.
Thank you to Groq for giving us access for free to their AI API. We are grateful for their support and collaboration.