Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 115 additions & 0 deletions edi_mail_import_oca/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
.. image:: https://odoo-community.org/readme-banner-image
:target: https://odoo-community.org/get-involved?utm_source=readme
:alt: Odoo Community Association

===================
Edi Mail Import Oca
===================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:aff4c256557f2507c286234eccc96a32869385fb0ab0fab7f5509a292ae01a43
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fedi--framework-lightgray.png?logo=github
:target: https://github.com/OCA/edi-framework/tree/19.0/edi_mail_import_oca
:alt: OCA/edi-framework
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/edi-framework-19-0/edi-framework-19-0-edi_mail_import_oca
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/edi-framework&target_branch=19.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module allows to process mails received as edi.exchange.records to
process them.

**Table of contents**

.. contents::
:local:

Use Cases / Context
===================

Usually, when we think about EDI entrances, we think about SFTP or API,
however, there is an standard way to receive files that is emails.

This module tries to offer a way to reuse EDI and mail interface in
order to handle everything.

Configuration
=============

For handling this incoming data, you just need to create a Backend and
define the alias.

The alias will be used to detect input mails. If the system detects an
email, it will take all the exchange types related to the backend and
review by exchange_filename if the pattern is filled. It will create a
new exchange record for each exchange type that fulfills:

1. Has the same backend type id
2. Has no backend or the backend is the current one
3. Has mail ``Mail Record Policy`` is ``full`` (it will generate a JSON
file with the full email) or the policy is ``pattern`` and there is a
file that follows the pattern (it will be used as the file for the
exchange record)

If not exchange type can be found, a UserError and a bounce email are
sent.

Processing will be handled in the standard way.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/edi-framework/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/edi-framework/issues/new?body=module:%20edi_mail_import_oca%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
-------

* Dixmit

Contributors
------------

- `Dixmit <https://www.dixmit.com>`__

- Enric Tobella

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

This module is part of the `OCA/edi-framework <https://github.com/OCA/edi-framework/tree/19.0/edi_mail_import_oca>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
1 change: 1 addition & 0 deletions edi_mail_import_oca/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import models
17 changes: 17 additions & 0 deletions edi_mail_import_oca/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Copyright 2026 Dixmit
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).

{
"name": "Edi Mail Import Oca",
"summary": """Process emails as EDI exchange recordsç""",
"version": "19.0.1.0.0",
"license": "AGPL-3",
"author": "Dixmit,Odoo Community Association (OCA)",
"website": "https://github.com/OCA/edi-framework",
"depends": ["edi_core_oca", "mail"],
"data": [
"views/edi_backend.xml",
"views/edi_exchange_type.xml",
],
"demo": [],
}
3 changes: 3 additions & 0 deletions edi_mail_import_oca/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
from . import edi_backend
from . import edi_exchange_record
from . import edi_exchange_type
31 changes: 31 additions & 0 deletions edi_mail_import_oca/models/edi_backend.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Copyright 2026 Dixmit
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
import ast

from odoo import models


class EdiBackend(models.Model):
_name = "edi.backend"
_inherit = ["edi.backend", "mail.alias.mixin"]

def _alias_get_creation_values(self):
values = super()._alias_get_creation_values()
values["alias_model_id"] = self.env["ir.model"]._get("edi.exchange.record").id
if self.id:
values["alias_defaults"] = defaults = ast.literal_eval(
self.alias_defaults or "{}"
)
defaults["backend_id"] = self.id
return values

def _mail_exchange_type_pending_input_domain(self):
"""Domain for retrieving input exchange types for emails."""
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add some more conventional constraint here.
What if we add specific type of backend Email and we rely on the fact that exc types refer to that type.
I would make it more clear from the configuration point of view.

return [
("backend_type_id", "=", self.backend_type_id.id),
("direction", "=", "input"),
"|",
("backend_id", "=", False),
("backend_id", "=", self.id),
("mail_record_policy", "!=", False),
]
97 changes: 97 additions & 0 deletions edi_mail_import_oca/models/edi_exchange_record.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# Copyright 2026 Dixmit
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
import base64
import email
import json
import logging
import re
from collections import defaultdict

from odoo import api, models
from odoo.exceptions import UserError

_logger = logging.getLogger(__name__)


class EdiExchangeRecord(models.Model):
_inherit = "edi.exchange.record"

@api.model
def message_new(self, msg_dict, custom_values=None):
backend_id = custom_values.get("backend_id") if custom_values else None
data = defaultdict(list)
if backend_id and not custom_values.get("type_id"):
backend = self.env["edi.backend"].browse(backend_id)
types = self.env["edi.exchange.type"].search(
backend._mail_exchange_type_pending_input_domain()
)
for exchange_type in types:
if exchange_type.mail_record_policy == "pattern":
for attachment in msg_dict.get("attachments", []):
if re.match(
exchange_type.exchange_filename_pattern,
attachment.fname,
re.IGNORECASE,
):
data[exchange_type.id].append(
[
attachment.fname,
self._process_email_attachment(attachment),
]
)
else:
new_message_dict = msg_dict.copy()
attachments = new_message_dict.pop("attachments", [])
new_message_dict["attachments"] = []
for attachment in attachments:
new_message_dict["attachments"].append(
{
"info": attachment.info,
"data": self._process_email_attachment(attachment),
"fname": attachment.fname,
}
)
data[exchange_type.id].append(
["email_message.json", json.dumps(new_message_dict)]
)
if (not custom_values or "type_id" not in custom_values) and not data:
raise UserError(
self.env._(
"No exchange type found for incoming email with subject '%s'",
msg_dict.get("subject"),
)
)
if data:
for exchange_type_id in data:
filename, content = data[exchange_type_id].pop()
custom_values["type_id"] = exchange_type_id
break
record = super().message_new(
msg_dict,
custom_values=custom_values,
)
if data:
record._set_file_content(content)
record.exchange_filename = filename
record.edi_exchange_state = "input_received"
for exchange_type_id in data:
for filename, content in data[exchange_type_id]:
new_record = record.copy(
default={
"type_id": exchange_type_id,
}
)
new_record._set_file_content(content)
new_record.exchange_filename = filename
new_record.edi_exchange_state = "input_received"
return record

@api.model
def _process_email_attachment(self, attachment):
"""Process email attachment to be stored as file content."""
data = attachment[1]
if isinstance(data, email.message.EmailMessage):
data = data.as_bytes()
if not isinstance(data, bytes):
data = str(data).encode("utf-8")
return base64.b64encode(data).decode("utf-8")
15 changes: 15 additions & 0 deletions edi_mail_import_oca/models/edi_exchange_type.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Copyright 2026 Dixmit
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).

from odoo import fields, models


class EdiExchangeType(models.Model):
_inherit = "edi.exchange.type"

mail_record_policy = fields.Selection(
[
("full", "Only archive the full mail message"),
("pattern", "Match single filename pattern"),
]
)
3 changes: 3 additions & 0 deletions edi_mail_import_oca/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["whool"]
build-backend = "whool.buildapi"
13 changes: 13 additions & 0 deletions edi_mail_import_oca/readme/CONFIGURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
For handling this incoming data, you just need to create a Backend and define the alias.

The alias will be used to detect input mails.
If the system detects an email, it will take all the exchange types related to the backend and review by exchange_filename if the pattern is filled.
It will create a new exchange record for each exchange type that fulfills:

1. Has the same backend type id
2. Has no backend or the backend is the current one
3. Has mail `Mail Record Policy` is `full` (it will generate a JSON file with the full email) or the policy is `pattern` and there is a file that follows the pattern (it will be used as the file for the exchange record)

If not exchange type can be found, a UserError and a bounce email are sent.

Processing will be handled in the standard way.
3 changes: 3 additions & 0 deletions edi_mail_import_oca/readme/CONTEXT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Usually, when we think about EDI entrances, we think about SFTP or API, however, there is an standard way to receive files that is emails.

This module tries to offer a way to reuse EDI and mail interface in order to handle everything.
2 changes: 2 additions & 0 deletions edi_mail_import_oca/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- [Dixmit](https://www.dixmit.com)
- Enric Tobella
1 change: 1 addition & 0 deletions edi_mail_import_oca/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This module allows to process mails received as edi.exchange.records to process them.
Binary file added edi_mail_import_oca/static/description/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading