mirror of
https://github.com/bringout/oca-ocb-mail.git
synced 2026-04-20 02:02:03 +02:00
Initial commit: Mail packages
This commit is contained in:
commit
4e53507711
1948 changed files with 751201 additions and 0 deletions
32
odoo-bringout-oca-ocb-mass_mailing/doc/ARCHITECTURE.md
Normal file
32
odoo-bringout-oca-ocb-mass_mailing/doc/ARCHITECTURE.md
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
# Architecture
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
U[Users] -->|HTTP| V[Views and QWeb Templates]
|
||||
V --> C[Controllers]
|
||||
V --> W[Wizards – Transient Models]
|
||||
C --> M[Models and ORM]
|
||||
W --> M
|
||||
M --> R[Reports]
|
||||
DX[Data XML] --> M
|
||||
S[Security – ACLs and Groups] -. enforces .-> M
|
||||
|
||||
subgraph Mass_mailing Module - mass_mailing
|
||||
direction LR
|
||||
M:::layer
|
||||
W:::layer
|
||||
C:::layer
|
||||
V:::layer
|
||||
R:::layer
|
||||
S:::layer
|
||||
DX:::layer
|
||||
end
|
||||
|
||||
classDef layer fill:#eef8ff,stroke:#6ea8fe,stroke-width:1px
|
||||
```
|
||||
|
||||
Notes
|
||||
- Views include tree/form/kanban templates and report templates.
|
||||
- Controllers provide website/portal routes when present.
|
||||
- Wizards are UI flows implemented with `models.TransientModel`.
|
||||
- Data XML loads data/demo records; Security defines groups and access.
|
||||
3
odoo-bringout-oca-ocb-mass_mailing/doc/CONFIGURATION.md
Normal file
3
odoo-bringout-oca-ocb-mass_mailing/doc/CONFIGURATION.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
# Configuration
|
||||
|
||||
Refer to Odoo settings for mass_mailing. Configure related models, access rights, and options as needed.
|
||||
17
odoo-bringout-oca-ocb-mass_mailing/doc/CONTROLLERS.md
Normal file
17
odoo-bringout-oca-ocb-mass_mailing/doc/CONTROLLERS.md
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
# Controllers
|
||||
|
||||
HTTP routes provided by this module.
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant U as User/Client
|
||||
participant C as Module Controllers
|
||||
participant O as ORM/Views
|
||||
|
||||
U->>C: HTTP GET/POST (routes)
|
||||
C->>O: ORM operations, render templates
|
||||
O-->>U: HTML/JSON/PDF
|
||||
```
|
||||
|
||||
Notes
|
||||
- See files in controllers/ for route definitions.
|
||||
13
odoo-bringout-oca-ocb-mass_mailing/doc/DEPENDENCIES.md
Normal file
13
odoo-bringout-oca-ocb-mass_mailing/doc/DEPENDENCIES.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# Dependencies
|
||||
|
||||
This addon depends on:
|
||||
|
||||
- [contacts](../../odoo-bringout-oca-ocb-contacts)
|
||||
- [mail](../../odoo-bringout-oca-ocb-mail)
|
||||
- [utm](../../odoo-bringout-oca-ocb-utm)
|
||||
- [link_tracker](../../odoo-bringout-oca-ocb-link_tracker)
|
||||
- [web_editor](../../odoo-bringout-oca-ocb-web_editor)
|
||||
- [web_kanban_gauge](../../odoo-bringout-oca-ocb-web_kanban_gauge)
|
||||
- [social_media](../../odoo-bringout-oca-ocb-social_media)
|
||||
- [web_tour](../../odoo-bringout-oca-ocb-web_tour)
|
||||
- [digest](../../odoo-bringout-oca-ocb-digest)
|
||||
4
odoo-bringout-oca-ocb-mass_mailing/doc/FAQ.md
Normal file
4
odoo-bringout-oca-ocb-mass_mailing/doc/FAQ.md
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
# FAQ
|
||||
|
||||
- Q: Which Odoo version? A: 16.0 (OCA/OCB packaged).
|
||||
- Q: How to enable? A: Start server with --addon mass_mailing or install in UI.
|
||||
7
odoo-bringout-oca-ocb-mass_mailing/doc/INSTALL.md
Normal file
7
odoo-bringout-oca-ocb-mass_mailing/doc/INSTALL.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# Install
|
||||
|
||||
```bash
|
||||
pip install odoo-bringout-oca-ocb-mass_mailing"
|
||||
# or
|
||||
uv pip install odoo-bringout-oca-ocb-mass_mailing"
|
||||
```
|
||||
31
odoo-bringout-oca-ocb-mass_mailing/doc/MODELS.md
Normal file
31
odoo-bringout-oca-ocb-mass_mailing/doc/MODELS.md
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
# Models
|
||||
|
||||
Detected core models and extensions in mass_mailing.
|
||||
|
||||
```mermaid
|
||||
classDiagram
|
||||
class ir_mail_server
|
||||
class mailing_contact
|
||||
class mailing_contact_subscription
|
||||
class mailing_filter
|
||||
class mailing_list
|
||||
class mailing_mailing
|
||||
class mailing_trace
|
||||
class res_users
|
||||
class ir_http
|
||||
class ir_model
|
||||
class link_tracker
|
||||
class link_tracker_click
|
||||
class mail_render_mixin
|
||||
class mail_thread
|
||||
class res_company
|
||||
class res_config_settings
|
||||
class res_partner
|
||||
class utm_campaign
|
||||
class utm_medium
|
||||
class utm_source
|
||||
```
|
||||
|
||||
Notes
|
||||
- Classes show model technical names; fields omitted for brevity.
|
||||
- Items listed under _inherit are extensions of existing models.
|
||||
6
odoo-bringout-oca-ocb-mass_mailing/doc/OVERVIEW.md
Normal file
6
odoo-bringout-oca-ocb-mass_mailing/doc/OVERVIEW.md
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
# Overview
|
||||
|
||||
Packaged Odoo addon: mass_mailing. Provides features documented in upstream Odoo 16 under this addon.
|
||||
|
||||
- Source: OCA/OCB 16.0, addon mass_mailing
|
||||
- License: LGPL-3
|
||||
26
odoo-bringout-oca-ocb-mass_mailing/doc/REPORTS.md
Normal file
26
odoo-bringout-oca-ocb-mass_mailing/doc/REPORTS.md
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
# Reports
|
||||
|
||||
Report definitions and templates in mass_mailing.
|
||||
|
||||
```mermaid
|
||||
classDiagram
|
||||
class MailingTraceReport
|
||||
Model <|-- MailingTraceReport
|
||||
```
|
||||
|
||||
## Available Reports
|
||||
|
||||
No named reports found in XML files.
|
||||
|
||||
|
||||
## Report Files
|
||||
|
||||
- **__init__.py** (Python logic)
|
||||
- **mailing_trace_report.py** (Python logic)
|
||||
- **mailing_trace_report_views.xml** (XML template/definition)
|
||||
|
||||
## Notes
|
||||
- Named reports above are accessible through Odoo's reporting menu
|
||||
- Python files define report logic and data processing
|
||||
- XML files contain report templates, definitions, and formatting
|
||||
- Reports are integrated with Odoo's printing and email systems
|
||||
42
odoo-bringout-oca-ocb-mass_mailing/doc/SECURITY.md
Normal file
42
odoo-bringout-oca-ocb-mass_mailing/doc/SECURITY.md
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
# Security
|
||||
|
||||
Access control and security definitions in mass_mailing.
|
||||
|
||||
## Access Control Lists (ACLs)
|
||||
|
||||
Model access permissions defined in:
|
||||
- **[ir.model.access.csv](../mass_mailing/security/ir.model.access.csv)**
|
||||
- 24 model access rules
|
||||
|
||||
## Record Rules
|
||||
|
||||
Row-level security rules defined in:
|
||||
|
||||
## Security Groups & Configuration
|
||||
|
||||
Security groups and permissions defined in:
|
||||
- **[res_groups_data.xml](../mass_mailing/security/res_groups_data.xml)**
|
||||
- 3 security groups defined
|
||||
|
||||
```mermaid
|
||||
graph TB
|
||||
subgraph "Security Layers"
|
||||
A[Users] --> B[Groups]
|
||||
B --> C[Access Control Lists]
|
||||
C --> D[Models]
|
||||
B --> E[Record Rules]
|
||||
E --> F[Individual Records]
|
||||
end
|
||||
```
|
||||
|
||||
Security files overview:
|
||||
- **[ir.model.access.csv](../mass_mailing/security/ir.model.access.csv)**
|
||||
- Model access permissions (CRUD rights)
|
||||
- **[res_groups_data.xml](../mass_mailing/security/res_groups_data.xml)**
|
||||
- Security groups, categories, and XML-based rules
|
||||
|
||||
Notes
|
||||
- Access Control Lists define which groups can access which models
|
||||
- Record Rules provide row-level security (filter records by user/group)
|
||||
- Security groups organize users and define permission sets
|
||||
- All security is enforced at the ORM level by Odoo
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# Troubleshooting
|
||||
|
||||
- Ensure Python and Odoo environment matches repo guidance.
|
||||
- Check database connectivity and logs if startup fails.
|
||||
- Validate that dependent addons listed in DEPENDENCIES.md are installed.
|
||||
7
odoo-bringout-oca-ocb-mass_mailing/doc/USAGE.md
Normal file
7
odoo-bringout-oca-ocb-mass_mailing/doc/USAGE.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# Usage
|
||||
|
||||
Start Odoo including this addon (from repo root):
|
||||
|
||||
```bash
|
||||
python3 scripts/odoo_web_server.py --db-name mydb --addon mass_mailing
|
||||
```
|
||||
13
odoo-bringout-oca-ocb-mass_mailing/doc/WIZARDS.md
Normal file
13
odoo-bringout-oca-ocb-mass_mailing/doc/WIZARDS.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# Wizards
|
||||
|
||||
Transient models exposed as UI wizards in mass_mailing.
|
||||
|
||||
```mermaid
|
||||
classDiagram
|
||||
class MailComposeMessage
|
||||
class MailingContactImport
|
||||
class MailingContactToList
|
||||
class MailingMailingScheduleDate
|
||||
class MassMailingListMerge
|
||||
class TestMassMailing
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue