diff --git a/edi_mail_import_oca/README.rst b/edi_mail_import_oca/README.rst new file mode 100644 index 000000000..a2c65cb57 --- /dev/null +++ b/edi_mail_import_oca/README.rst @@ -0,0 +1,88 @@ +=================== +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/licence-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/17.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-17-0/edi-framework-17-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=17.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. + +Bug Tracker +=========== + +Bugs are tracked on `GitHub 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 `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +------- + +* Dixmit + +Contributors +------------ + +- `Dixmit `__ + + - 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 `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/edi_mail_import_oca/__init__.py b/edi_mail_import_oca/__init__.py new file mode 100644 index 000000000..0650744f6 --- /dev/null +++ b/edi_mail_import_oca/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/edi_mail_import_oca/__manifest__.py b/edi_mail_import_oca/__manifest__.py new file mode 100644 index 000000000..5d35edc94 --- /dev/null +++ b/edi_mail_import_oca/__manifest__.py @@ -0,0 +1,16 @@ +# 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": "17.0.1.0.0", + "license": "AGPL-3", + "author": "Dixmit,Odoo Community Association (OCA)", + "website": "https://github.com/OCA/edi-framework", + "depends": ["edi_oca", "mail"], + "data": [ + "views/edi_exchange_type.xml", + ], + "demo": [], +} diff --git a/edi_mail_import_oca/models/__init__.py b/edi_mail_import_oca/models/__init__.py new file mode 100644 index 000000000..6128f744d --- /dev/null +++ b/edi_mail_import_oca/models/__init__.py @@ -0,0 +1,2 @@ +from . import edi_exchange_type +from . import edi_exchange_record diff --git a/edi_mail_import_oca/models/edi_exchange_record.py b/edi_mail_import_oca/models/edi_exchange_record.py new file mode 100644 index 000000000..0fc39c7da --- /dev/null +++ b/edi_mail_import_oca/models/edi_exchange_record.py @@ -0,0 +1,65 @@ +# 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 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): + record = super().message_new( + msg_dict, + custom_values=custom_values, + ) + if record.type_id.direction != "input": + raise UserError(_("Received email for non-incoming exchange type.")) + if record.type_id.mail_as_attachment: + 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, + } + ) + record._set_file_content(json.dumps(new_message_dict)) + record.edi_exchange_state = "input_received" + else: + content = False + filename = False + for attachment in msg_dict.get("attachments", []): + if re.match( + record.type_id.exchange_filename_pattern or ".*", + attachment.fname, + re.IGNORECASE, + ): + content = self._process_email_attachment(attachment) + filename = attachment.fname + break + if content: + record._set_file_content(content) + record.exchange_filename = filename + record.edi_exchange_state = "input_received" + return record + + 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") diff --git a/edi_mail_import_oca/models/edi_exchange_type.py b/edi_mail_import_oca/models/edi_exchange_type.py new file mode 100644 index 000000000..2856f8262 --- /dev/null +++ b/edi_mail_import_oca/models/edi_exchange_type.py @@ -0,0 +1,27 @@ +# Copyright 2026 Dixmit +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). +import ast + +from odoo import fields, models + + +class EdiExchangeType(models.Model): + _name = "edi.exchange.type" + _inherit = ["edi.exchange.type", "mail.alias.mixin"] + + mail_as_attachment = fields.Boolean( + string="Import Email as an Attachment", + ) + + def _alias_get_creation_values(self): + values = super()._alias_get_creation_values() + values["alias_model_id"] = ( + self.env["ir.model"].sudo()._get("edi.exchange.record").id + ) + if self.id: + values["alias_defaults"] = defaults = ast.literal_eval( + self.alias_defaults or "{}" + ) + defaults["backend_id"] = self.backend_id.id + defaults["type_id"] = self.id + return values diff --git a/edi_mail_import_oca/pyproject.toml b/edi_mail_import_oca/pyproject.toml new file mode 100644 index 000000000..4231d0ccc --- /dev/null +++ b/edi_mail_import_oca/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/edi_mail_import_oca/readme/CONTEXT.md b/edi_mail_import_oca/readme/CONTEXT.md new file mode 100644 index 000000000..75b5eb86e --- /dev/null +++ b/edi_mail_import_oca/readme/CONTEXT.md @@ -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. \ No newline at end of file diff --git a/edi_mail_import_oca/readme/CONTRIBUTORS.md b/edi_mail_import_oca/readme/CONTRIBUTORS.md new file mode 100644 index 000000000..2c066ba7f --- /dev/null +++ b/edi_mail_import_oca/readme/CONTRIBUTORS.md @@ -0,0 +1,2 @@ +- [Dixmit](https://www.dixmit.com) + - Enric Tobella diff --git a/edi_mail_import_oca/readme/DESCRIPTION.md b/edi_mail_import_oca/readme/DESCRIPTION.md new file mode 100644 index 000000000..0c3f0ceba --- /dev/null +++ b/edi_mail_import_oca/readme/DESCRIPTION.md @@ -0,0 +1 @@ +This module allows to process mails received as edi.exchange.records to process them. diff --git a/edi_mail_import_oca/static/description/icon.png b/edi_mail_import_oca/static/description/icon.png new file mode 100644 index 000000000..3a0328b51 Binary files /dev/null and b/edi_mail_import_oca/static/description/icon.png differ diff --git a/edi_mail_import_oca/static/description/index.html b/edi_mail_import_oca/static/description/index.html new file mode 100644 index 000000000..e987802ad --- /dev/null +++ b/edi_mail_import_oca/static/description/index.html @@ -0,0 +1,435 @@ + + + + + +Edi Mail Import Oca + + + +
+

Edi Mail Import Oca

+ + +

Beta License: AGPL-3 OCA/edi-framework Translate me on Weblate Try me on Runboat

+

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

+

Table of contents

+ +
+

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.

+
+
+

Bug Tracker

+

Bugs are tracked on GitHub 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.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • Dixmit
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

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 project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/edi_mail_import_oca/tests/__init__.py b/edi_mail_import_oca/tests/__init__.py new file mode 100644 index 000000000..51632faa6 --- /dev/null +++ b/edi_mail_import_oca/tests/__init__.py @@ -0,0 +1 @@ +from . import test_mail_import_oca diff --git a/edi_mail_import_oca/tests/test_mail_import_oca.py b/edi_mail_import_oca/tests/test_mail_import_oca.py new file mode 100644 index 000000000..75522b6d8 --- /dev/null +++ b/edi_mail_import_oca/tests/test_mail_import_oca.py @@ -0,0 +1,124 @@ +# Part of Odoo. See LICENSE file for full copyright and licensing details. + +import json + +from odoo.tests import tagged + +from odoo.addons.mail.tests.common import MailCommon +from odoo.addons.test_mail.data.test_mail_data import MAIL_EML_ATTACHMENT + + +@tagged("mail_gateway") +class TestEmailParsing(MailCommon): + """Test email parsing and import via mail gateway""" + + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.backend_type = cls.env["edi.backend.type"].create( + { + "name": "Mail Import OCA Test Backend Type", + "code": "mail_import_oca_test_backend_type", + } + ) + cls.backend = cls.env["edi.backend"].create( + { + "name": "Mail Import OCA Test Backend", + "backend_type_id": cls.backend_type.id, + } + ) + cls.exchange_type = cls.env["edi.exchange.type"].create( + { + "name": "Test Exchange Type", + "code": "test_exchange_type", + "direction": "input", + "alias_name": "edi-input", + "backend_type_id": cls.backend_type.id, + "backend_id": cls.backend.id, + } + ) + + def test_import_full(self): + self.assertTrue(self.exchange_type.alias_email) + self.exchange_type.mail_as_attachment = True + self.assertFalse( + self.env["edi.exchange.record"].search( + [ + ("type_id", "=", self.exchange_type.id), + ] + ) + ) + mail = self.format( + MAIL_EML_ATTACHMENT, + to=self.exchange_type.alias_email, + subject="purchase test mail", + target_model="account.move", + msg_id="", + ) + self.env["mail.thread"].message_process("mail.thread", mail) + record = self.env["edi.exchange.record"].search( + [ + ("type_id", "=", self.exchange_type.id), + ] + ) + self.assertTrue(record) + self.assertEqual(record.edi_exchange_state, "input_received") + file_content = record._get_file_content() + self.assertTrue(file_content) + data = json.loads(file_content) + self.assertIn("body", data) + + def test_import_specific_file(self): + self.assertTrue(self.exchange_type.alias_email) + self.exchange_type.mail_as_attachment = False + self.exchange_type.exchange_filename_pattern = ".*eml" + self.assertFalse( + self.env["edi.exchange.record"].search( + [ + ("type_id", "=", self.exchange_type.id), + ] + ) + ) + mail = self.format( + MAIL_EML_ATTACHMENT, + to=self.exchange_type.alias_email, + subject="purchase test mail", + target_model="account.move", + msg_id="", + ) + self.env["mail.thread"].message_process("mail.thread", mail) + record = self.env["edi.exchange.record"].search( + [ + ("type_id", "=", self.exchange_type.id), + ] + ) + self.assertTrue(record) + self.assertEqual(record.edi_exchange_state, "input_received") + self.assertEqual(record.exchange_filename, "original_msg.eml") + + def test_import_no_file_found(self): + self.assertTrue(self.exchange_type.alias_email) + self.exchange_type.mail_as_attachment = False + self.exchange_type.exchange_filename_pattern = ".*xml" + self.assertFalse( + self.env["edi.exchange.record"].search( + [ + ("type_id", "=", self.exchange_type.id), + ] + ) + ) + mail = self.format( + MAIL_EML_ATTACHMENT, + to=self.exchange_type.alias_email, + subject="purchase test mail", + target_model="account.move", + msg_id="", + ) + self.env["mail.thread"].message_process("mail.thread", mail) + record = self.env["edi.exchange.record"].search( + [ + ("type_id", "=", self.exchange_type.id), + ] + ) + self.assertTrue(record) + self.assertEqual(record.edi_exchange_state, "new") diff --git a/edi_mail_import_oca/views/edi_exchange_type.xml b/edi_mail_import_oca/views/edi_exchange_type.xml new file mode 100644 index 000000000..217a80b4c --- /dev/null +++ b/edi_mail_import_oca/views/edi_exchange_type.xml @@ -0,0 +1,54 @@ + + + + + + edi.exchange.type + + + + +
+ + + +
+ + + + + + + + + + +