Merge pull request #27 from mxtoai/rate-limit

Add Rate Limiting, Update docs with why to use section

Author: satwikkansal

docusaurus-site/docs/why-use-mxtoai.md

@@ -0,0 +1,221 @@
+# MXtoAI Use Cases
+
+⚡ **The Magic: Zero Setup Required**
+
+- No new apps to learn - works with your existing email
+- No account creation - just whitelist your email and start forwarding
+- No data stored - your emails are processed and immediately deleted
+- Works anywhere - Gmail, Outlook, Apple Mail, even your phone
+- Works with attachments - PDFs, images, spreadsheets all processed
+- Works with email threads - understands context from conversation history
+
+As simple as it sounds, MXtoAI is very powerful. If you spend more than 10 minutes a day reading, understanding, or responding to emails, MXtoAI can probably save you time and mental energy. Whether you're dealing with work emails, personal correspondence, or staying informed, there's likely a use case that fits your daily routine. Here are some use-cases you can use it for.
+
+## 📧 Daily Email Management
+
+**"I get too many newsletters and updates"**
+- Forward newsletters to summarize@mxtoai.com - get key points in 2-3 sentences
+- Set up auto-forwarding rules so all newsletters get auto-summarized daily
+
+**"I receive emails in different languages"**
+- Forward to translate@mxtoai.com - instantly get English translations
+- Perfect for international business or foreign language newsletters
+
+**"Complex emails confuse me"**
+- Forward technical/legal emails to simplify@mxtoai.com - get plain English explanations
+- Great for insurance documents, contracts, or technical announcements
+
+**"I'm drowning in promotional emails"**
+- Forward deals/offers to ask@mxtoai.com with "Is this actually a good deal?"
+- Get honest comparisons and price checks
+
+## 🤝 Meeting & Scheduling
+
+**"Coordinating meetings is a nightmare"**
+- Forward scheduling emails to schedule@mxtoai.com
+- Get back .ics calendar files with suggested meeting times
+- Works with "Can we meet next week?" or complex group scheduling
+
+**"I need to prepare for meetings with new people"**
+- Forward meeting invites to background@mxtoai.com
+- Get LinkedIn profiles, company info, recent news about attendees
+
+**"I forgot what we discussed in previous emails"**
+- Forward email threads to summarize@mxtoai.com
+- Get context and key points before the meeting
+
+**"I need to follow up after meetings"**
+- Forward meeting notes to ask@mxtoai.com with "Draft follow-up email"
+- Get professional action items and next steps
+
+## 💼 Business & Work
+
+**"I get invoices and need to check calculations"**
+- Forward invoices to ask@mxtoai.com with "Check if this math is correct"
+- Catches billing errors automatically
+
+**"I need to research companies/people quickly"**
+- Forward emails mentioning companies to background@mxtoai.com
+- Get company size, recent news, key executives, competitors
+
+**"I receive reports and need quick insights"**
+- Forward quarterly reports to summarize@mxtoai.com
+- Get key metrics and trends without reading 20 pages
+
+**"I receive contracts and legal documents"**
+- Forward to simplify@mxtoai.com - understand key terms and obligations
+- Forward to ask@mxtoai.com with "What are the risks here?"
+
+**"I get RFPs and proposals to review"**
+- Forward to summarize@mxtoai.com - get key requirements and deadlines
+- Forward to ask@mxtoai.com with "What's our competitive advantage here?"
+
+## 🔍 Information Verification & Research
+
+**"I get forwarded news and want to check if it's true"**
+- Forward suspicious emails to factcheck@mxtoai.com
+- Get verification with sources - perfect for avoiding misinformation
+
+**"I need to verify claims in marketing emails"**
+- Forward promotional content to factcheck@mxtoai.com
+- Check if "50% off" is really a discount or if testimonials are real
+
+**"I want to research investments or financial advice"**
+- Forward investment newsletters to research@mxtoai.com
+- Get company fundamentals, recent performance, analyst opinions
+
+**"I need to check competitor information"**
+- Forward competitor emails to background@mxtoai.com
+- Get market position, recent moves, customer feedback
+
+## 🏠 Personal Life
+
+**"I get complex medical/insurance emails"**
+- Forward to simplify@mxtoai.com - understand your benefits, procedures, costs
+- No more confusion about medical bills or insurance claims
+
+**"I get travel confirmations and want to know more about destinations"**
+- Forward booking confirmations to background@mxtoai.com
+- Get weather, local attractions, cultural tips
+
+**"I receive home service estimates"**
+- Forward contractor quotes to ask@mxtoai.com with "Is this price fair?"
+- Get market rates and red flags to watch for
+
+**"I get tax documents and financial statements"**
+- Forward to simplify@mxtoai.com - understand what you owe/are owed
+- Forward to ask@mxtoai.com with "What deductions am I missing?"
+
+**"I receive HOA notices and community updates"**
+- Forward lengthy community emails to summarize@mxtoai.com
+- Get key dates, rule changes, and action items
+
+## 🎓 Education & Learning
+
+**"I want to stay informed but don't have time to read everything"**
+- Forward industry newsletters to summarize@mxtoai.com
+- Set up daily digest of key news in your field
+
+**"I receive academic papers or technical articles"**
+- Forward to simplify@mxtoai.com - get key findings in simple terms
+- Perfect for staying current without deep technical reading
+
+**"I get course announcements and need to prioritize"**
+- Forward educational emails to ask@mxtoai.com with "Which courses are worth my time?"
+- Get recommendations based on your goals
+
+**"I receive research papers and need quick insights"**
+- Forward to ask@mxtoai.com with "What are the practical applications?"
+- Understand real-world relevance quickly
+
+## 🛍️ Shopping & Consumer Decisions
+
+**"I get overwhelmed by product comparison emails"**
+- Forward to simplify@mxtoai.com - get clear feature comparisons
+- Perfect for software, cars, appliances
+
+**"I receive warranty and service emails"**
+- Forward to ask@mxtoai.com with "What does this actually cover?"
+- Understand terms without legal jargon
+
+**"I get subscription renewal notices"**
+- Forward to ask@mxtoai.com with "Is this still worth it?"
+- Get usage analysis and alternatives
+
+**"I receive recall notices and safety alerts"**
+- Forward to ask@mxtoai.com with "How urgent is this?"
+- Understand if immediate action is needed
+
+## 💰 Financial Management
+
+**"I get bank statements and credit card bills"**
+- Forward to ask@mxtoai.com with "Any unusual charges or patterns?"
+- Spot fraud and track spending trends
+
+**"I receive investment updates and market reports"**
+- Forward to simplify@mxtoai.com - understand impact on your portfolio
+- Get action recommendations in plain English
+
+**"I get loan offers and financial product emails"**
+- Forward to ask@mxtoai.com with "Is this a good deal for my situation?"
+- Get personalized pros/cons analysis
+
+**"I receive tax-related emails from accountants"**
+- Forward to simplify@mxtoai.com - understand deadlines and requirements
+- No more confusion about filing obligations
+
+## 🏥 Healthcare & Wellness
+
+**"I get lab results and medical reports"**
+- Forward to simplify@mxtoai.com - understand what results mean
+- Get context on normal ranges and next steps
+
+**"I receive appointment confirmations with prep instructions"**
+- Forward to summarize@mxtoai.com - get clear to-do lists
+- Never miss pre-appointment requirements
+
+**"I get emails about new treatments or procedures"**
+- Forward to ask@mxtoai.com with "What are the risks and benefits?"
+- Make informed healthcare decisions
+
+**"I receive wellness newsletters with conflicting advice"**
+- Forward to factcheck@mxtoai.com - verify health claims
+- Separate science from marketing
+
+## 🎯 Real-World Examples by Profession
+
+**Small Business Owner:**
+- "I forward customer complaints to ask@mxtoai.com with 'Draft empathetic response' - turns angry customers into loyal ones"
+- "I forward supplier emails to background@mxtoai.com before negotiations - know their financial health"
+
+**Job Seeker:**
+- "I forward job postings to background@mxtoai.com to research company culture before applying"
+- "I forward interview invites to ask@mxtoai.com with 'Help me research this role' for better preparation"
+
+**Investor:**
+- "I forward earnings emails to summarize@mxtoai.com for quick portfolio updates"
+- "I forward analyst reports to ask@mxtoai.com with 'What's the contrarian view?' for balanced perspective"
+
+**Consultant:**
+- "I forward client emails to background@mxtoai.com before meetings to understand industry challenges"
+- "I forward RFPs to ask@mxtoai.com with 'What's the hidden agenda here?' to win more bids"
+
+**Retiree:**
+- "I forward Medicare emails to simplify@mxtoai.com - healthcare is confusing enough"
+- "I forward financial advisor emails to ask@mxtoai.com with 'Is this advice suitable for my age?'"
+
+**Student:**
+- "I forward professor emails to summarize@mxtoai.com to catch important deadlines"
+- "I forward scholarship announcements to ask@mxtoai.com with 'Am I eligible for this?'"
+
+**Freelancer:**
+- "I forward client project briefs to ask@mxtoai.com with 'What questions should I ask?'"
+- "I forward contract negotiations to ask@mxtoai.com with 'What am I missing in this deal?'"
+
+**Real Estate Agent:**
+- "I forward property listings to background@mxtoai.com for neighborhood insights"
+- "I forward mortgage documents to simplify@mxtoai.com to explain terms to clients"
+
+**Healthcare Worker:**
+- "I forward policy updates to summarize@mxtoai.com - regulations change constantly"
+- "I forward research emails to ask@mxtoai.com with 'How does this apply to my patients?'"

mxtoai/api.py

@@ -1,12 +1,14 @@
 import json
 import os
 import shutil
+from contextlib import asynccontextmanager
 from datetime import datetime
 from email.utils import getaddresses
 from pathlib import Path
 from typing import Annotated, Any, Optional
 
 import aiofiles
+import redis.asyncio as aioredis
 from dotenv import load_dotenv
 from fastapi import Depends, FastAPI, File, Form, HTTPException, Response, UploadFile, status
 from fastapi.security import APIKeyHeader
@@ -19,18 +21,73 @@
     generate_email_id,
     send_email_reply,
 )
-from mxtoai.schemas import EmailAttachment, EmailRequest
+from mxtoai.schemas import EmailAttachment, EmailRequest, RateLimitPlan
 from mxtoai.tasks import process_email_task
-from mxtoai.validators import validate_api_key, validate_attachments, validate_email_handle, validate_email_whitelist
+from mxtoai.validators import (
+    email_provider_domain_set as validator_email_provider_domain_set,
+)
+from mxtoai.validators import (
+    validate_api_key,
+    validate_attachments,
+    validate_email_handle,
+    validate_email_whitelist,
+    validate_rate_limits,
+)
+from mxtoai import validators
 
 # Load environment variables
 load_dotenv()
+REDIS_URL = os.getenv("REDIS_URL", "redis://localhost:6379/0")
 
 # Configure logging
 logger = get_logger(__name__)
 
-app = FastAPI()
-if os.getenv("IS_PROD", "true").lower() == "true":
+
+# Lifespan manager for app startup and shutdown
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    # Startup
+    logger.info("Application startup: Initializing Redis client for rate limiter...")
+    try:
+        validators.redis_client = aioredis.from_url(REDIS_URL, encoding="utf-8", decode_responses=True)
+        await validators.redis_client.ping()
+        logger.info(f"Redis client connected for rate limiting: {REDIS_URL}")
+    except Exception as e:
+        logger.error(f"Could not connect to Redis for rate limiting at {REDIS_URL}: {e}")
+        validators.redis_client = None
+
+    # Load email provider domains
+    global validator_email_provider_domain_set
+    try:
+        current_dir = Path(__file__).parent
+        domains_file_path = current_dir / "email_provider_domains.txt"
+        if not domains_file_path.exists():
+            domains_file_path = Path("mxtoai/email_provider_domains.txt")
+
+        if domains_file_path.exists():
+            with open(domains_file_path) as f:
+                validator_email_provider_domain_set.update([line.strip().lower() for line in f if line.strip()])
+            logger.info(
+                f"Loaded {len(validator_email_provider_domain_set)} email provider domains for rate limit exclusion."
+            )
+        else:
+            logger.warning(
+                f"Email provider domains file not found at {domains_file_path}. Domain-specific rate limits might not work as expected."
+            )
+    except Exception as e:
+        logger.error(f"Error loading email provider domains: {e}")
+
+    yield  # Application runs here
+
+    # Shutdown
+    logger.info("Application shutdown: Closing Redis client...")
+    if validators.redis_client:
+        await validators.redis_client.aclose()
+        logger.info("Redis client closed.")
+
+
+app = FastAPI(lifespan=lifespan)
+if os.environ["IS_PROD"].lower() == "true":
     app.openapi_url = None
 
 api_auth_scheme = APIKeyHeader(name="x-api-key", auto_error=True)
@@ -414,6 +471,10 @@ async def process_email(
     if response := await validate_api_key(api_key):
         return response
 
+    # Validate rate limits before other processing
+    if response := await validate_rate_limits(from_email, to, subject, messageId, plan=RateLimitPlan.BETA):
+        return response
+
     if files is None:
         files = []
     parsed_headers = {}