Schema: ai_sam_email_marketing

Technical Truth - Models, API endpoints, and data structures

Module Overview

Models

ai.email.campaign (Primary Model)

Purpose: Manages AI-powered email marketing campaigns with context for AI understanding.

Key Methods:
| Method | Purpose | Returns |
|--------|---------|---------|
| action_open_ai_builder() | Open AI Email Builder interface | Client action |
| action_view_templates() | View generated templates | Window action |
| action_view_mailings() | View created mailings | Window action |
| get_ai_context() | Get campaign context for AI | dict |

Relationships:
- template_ids → ai.email.template (One2many)
- generation_request_ids → ai.email.generation.request (One2many)
- mailing_ids → mailing.mailing (One2many)

ai.email.template

Purpose: Stores AI-generated email templates with versioning and conversion to Odoo mailings.

Key Methods:
| Method | Purpose | Returns |
|--------|---------|---------|
| action_create_mailing() | Create Odoo mailing from template | Window action |
| action_preview() | Preview email template | URL action |
| action_approve() | Approve template | None |
| get_generation_metadata_dict() | Parse metadata JSON | dict |
| create_new_version() | Create new version with updates | ai.email.template |

Relationships:
- campaign_id → ai.email.campaign (Many2one)
- generation_request_id → ai.email.generation.request (Many2one)
- parent_template_id → ai.email.template (Many2one)
- mailing_id → mailing.mailing (Many2one)

ai.email.generation.request

Purpose: Tracks AI generation requests for audit trail, chat history, and cost analytics.

Key Methods:
| Method | Purpose | Returns |
|--------|---------|---------|
| action_retry() | Retry failed request | Window action |
| create_template_from_response() | Create template from AI response | ai.email.template |
| parse_ai_response_json() | Parse AI response as JSON | dict |
| get_chat_message_format() | Format for chat UI display | dict |

mailing.mailing (Inherited)

Purpose: Extends Odoo's mailing model with AI campaign link.

Controllers / API Endpoints

AIEmailController

File: controllers/ai_email_controller.py

Request/Response Examples

POST /ai_email_marketing/upload

Request (multipart/form-data):

campaign_id: 42
file: (binary file content)

Response:

{
    "success": true,
    "request_id": 123,
    "file_name": "newsletter.md",
    "file_type": "markdown"
}

GET /ai_email_marketing/preview/123

Response: HTML page with rendered email preview in container.

POST /ai_email_marketing/generate (JSON-RPC)

Request:

{
    "jsonrpc": "2.0",
    "method": "call",
    "params": {
        "campaign_id": 42,
        "prompt": "Create a promotional email for our summer sale with 30% off all items",
        "request_type": "generate",
        "previous_template_id": null
    }
}

Response:

{
    "success": true,
    "request_id": 456
}

Data Relationships Diagram

┌─────────────────────────────┐
│   ai.email.campaign         │
│                             │
│  - name                     │
│  - campaign_type            │
│  - target_audience          │
│  - tone                     │
│  - state                    │
└──────────┬──────────────────┘
           │
           │ One2many
           ├───────────────────────────────┐
           ▼                               ▼
┌─────────────────────────┐    ┌─────────────────────────────┐
│   ai.email.template     │    │ ai.email.generation.request │
│                         │    │                             │
│  - subject              │◄───│  - result_template_id       │
│  - preheader            │    │  - prompt                   │
│  - body_html            │    │  - request_type             │
│  - version              │    │  - tokens_used              │
│  - is_latest            │    │  - state                    │
│  - parent_template_id   │    └─────────────────────────────┘
└──────────┬──────────────┘
           │
           │ Creates
           ▼
┌─────────────────────────┐
│   mailing.mailing       │
│   (Odoo Native)         │
│                         │
│  - ai_campaign_id       │
│  - ai_template_id       │
└─────────────────────────┘

Security Rules

Database Tables

Change History