diff --git a/fetchmail_thread_default/README.rst b/fetchmail_thread_default/README.rst new file mode 100644 index 00000000..df2da8f2 --- /dev/null +++ b/fetchmail_thread_default/README.rst @@ -0,0 +1,93 @@ +.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 + +=================================== +Default Thread For Unbounded Emails +=================================== + +This module extends the functionality of mail fetching to support choosing a +mail thread that acts as a mail sink and gathers all mail messages that Odoo +does not know where to put. + +Dangling emails are really a problem because if you do not care about them, +SPAM can enter your inbox and keep increasing fetchmail process network quota +because Odoo would gather them every time it runs the fetchmail process. + +Before this, your only choice was to create a new record for those unbounded +emails. That could be useful under some circumstances, like creating a +``crm.lead`` for them, but what happens if you do not want to have lots of +spammy leads? Or if you do not need Odoo's CRM at all? + +Here we come to the rescue. This simple addons adds almost none dependencies +and allows you to direct those mails somewhere you can handle or ignore at +wish. + +Configuration +============= + +To configure this module, you need to: + +#. Go to *Settings > General Settings > Configure the incoming email gateway*. +#. Create or edit a record. +#. Configure properly. +#. Under *Default mail thread*, choose a model and record. + + Tip: if you do not know what to choose, we suggest you to use a mail + channel. + +Usage +===== + +To use this module, you need to: + +#. Subscribe to the thread you chose as the *Default mail thread*. +#. You will be notified when a new unbound email lands in that thread. +#. Do what you want with it. + +.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas + :alt: Try me on Runbot + :target: https://runbot.odoo-community.org/runbot/205/9.0 + +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 smash it by providing detailed and welcomed feedback. + +Credits +======= + +Images +------ + +* Odoo Community Association: `Icon `_. + +Contributors +------------ + +* Jairo Llopis + +Funders +------- + +The development of this module has been financially supported by: + +* `Tecnativa `_. + +Maintainer +---------- + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +This module is maintained by the OCA. + +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. + +To contribute to this module, please visit https://odoo-community.org. diff --git a/fetchmail_thread_default/__init__.py b/fetchmail_thread_default/__init__.py new file mode 100644 index 00000000..1ed5d56b --- /dev/null +++ b/fetchmail_thread_default/__init__.py @@ -0,0 +1,5 @@ +# -*- coding: utf-8 -*- +# Copyright 2017 Jairo Llopis +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from . import models diff --git a/fetchmail_thread_default/__openerp__.py b/fetchmail_thread_default/__openerp__.py new file mode 100644 index 00000000..f78572a9 --- /dev/null +++ b/fetchmail_thread_default/__openerp__.py @@ -0,0 +1,23 @@ +# -*- coding: utf-8 -*- +# Copyright 2017 Jairo Llopis +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). +{ + "name": "Default Thread For Unbounded Emails", + "summary": "Post unkonwn messages to an existing thread", + "version": "9.0.1.0.0", + "category": "Discuss", + "website": "https://www.tecnativa.com/", + "author": "Tecnativa, Odoo Community Association (OCA)", + "license": "AGPL-3", + "application": False, + "installable": True, + "depends": [ + "fetchmail", + ], + "data": [ + "views/fetchmail_server_view.xml", + ], + "demo": [ + "demo/data.xml", + ], +} diff --git a/fetchmail_thread_default/demo/data.xml b/fetchmail_thread_default/demo/data.xml new file mode 100644 index 00000000..14a6a95e --- /dev/null +++ b/fetchmail_thread_default/demo/data.xml @@ -0,0 +1,24 @@ + + + + + + + mailsink + + Unbounded email sink + everyone + private + + + + + Demo server + pop + pop3.example.com + + + + + diff --git a/fetchmail_thread_default/i18n/.empty b/fetchmail_thread_default/i18n/.empty new file mode 100644 index 00000000..e69de29b diff --git a/fetchmail_thread_default/models/__init__.py b/fetchmail_thread_default/models/__init__.py new file mode 100644 index 00000000..83b4f275 --- /dev/null +++ b/fetchmail_thread_default/models/__init__.py @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# Copyright 2017 Jairo Llopis +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from . import fetchmail_server +from . import mail_thread diff --git a/fetchmail_thread_default/models/fetchmail_server.py b/fetchmail_thread_default/models/fetchmail_server.py new file mode 100644 index 00000000..8763fc7f --- /dev/null +++ b/fetchmail_thread_default/models/fetchmail_server.py @@ -0,0 +1,49 @@ +# -*- coding: utf-8 -*- +# Copyright 2017 Jairo Llopis +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from openerp import api, fields, models + + +class FetchmailServer(models.Model): + _inherit = "fetchmail.server" + + default_thread_id = fields.Reference( + selection="_get_thread_models", + string="Default mail thread", + help="Messages with no clear route will be posted as a new message " + "to this thread.", + ) + + @api.model + def _get_thread_models(self): + """Get list of available ``mail.thread`` submodels. + + :return [(model, name), ...]: + Tuple list of available models that can receive messages. + """ + models = self.env["ir.model.fields"].search([ + ("name", "=", "message_partner_ids"), + ]).mapped("model_id") + # Exclude AbstractModel + return [(m.model, m.name) for m in models + if getattr(self.env[m.model], "_auto")] + + # TODO New api on v10+ + # pylint: disable=old-api7-method-defined + def onchange_server_type(self, cr, uid, ids, server_type=False, ssl=False, + object_id=False): + """Remove :attr:`default_thread_id` if there is :attr:`object_id`.""" + result = super(FetchmailServer, self).onchange_server_type( + cr, uid, ids, server_type, ssl, object_id, + ) + if object_id: + result["value"]["default_thread_id"] = False + return result + + @api.multi + @api.onchange("default_thread_id") + def _onchange_remove_object_id(self): + """Remove :attr:`object_id` if there is :attr:`default_thread_id`.""" + if self.default_thread_id: + self.object_id = False diff --git a/fetchmail_thread_default/models/mail_thread.py b/fetchmail_thread_default/models/mail_thread.py new file mode 100644 index 00000000..58075ffa --- /dev/null +++ b/fetchmail_thread_default/models/mail_thread.py @@ -0,0 +1,30 @@ +# -*- coding: utf-8 -*- +# Copyright 2017 Jairo Llopis +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from openerp import api, models + + +class MailThread(models.AbstractModel): + _inherit = "mail.thread" + + @api.model + def message_process(self, model, message, custom_values=None, + save_original=False, strip_attachments=False, + thread_id=None): + server = self.env["fetchmail.server"].browse( + self.env.context.get("fetchmail_server_id")) + if server.default_thread_id and not (model or thread_id): + model = server.default_thread_id._name + thread_id = server.default_thread_id.id + return super( + MailThread, + self.with_context(mail_create_nosubscribe=True) + ).message_process( + model, + message, + custom_values, + save_original, + strip_attachments, + thread_id, + ) diff --git a/fetchmail_thread_default/static/description/icon.png b/fetchmail_thread_default/static/description/icon.png new file mode 100644 index 00000000..3a0328b5 Binary files /dev/null and b/fetchmail_thread_default/static/description/icon.png differ diff --git a/fetchmail_thread_default/tests/__init__.py b/fetchmail_thread_default/tests/__init__.py new file mode 100644 index 00000000..13102356 --- /dev/null +++ b/fetchmail_thread_default/tests/__init__.py @@ -0,0 +1,5 @@ +# -*- coding: utf-8 -*- +# Copyright 2017 Jairo Llopis +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from . import test_fetchmail diff --git a/fetchmail_thread_default/tests/test_fetchmail.py b/fetchmail_thread_default/tests/test_fetchmail.py new file mode 100644 index 00000000..f245997b --- /dev/null +++ b/fetchmail_thread_default/tests/test_fetchmail.py @@ -0,0 +1,61 @@ +# -*- coding: utf-8 -*- +# Copyright 2017 Jairo Llopis +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from openerp.addons.mail.tests.test_mail_gateway import MAIL_TEMPLATE +from openerp.tests.common import SavepointCase +from openerp.tools import mute_logger + + +class FetchmailCase(SavepointCase): + @classmethod + def setUpClass(cls): + super(FetchmailCase, cls).setUpClass() + cls.server = cls.env.ref("fetchmail_thread_default.demo_server") + cls.sink = cls.env.ref("fetchmail_thread_default.demo_sink") + cls.MailThread = cls.env["mail.thread"] + + def test_available_models(self): + """Non-``mail.thread`` models don't appear.""" + for record in self.server._get_thread_models(): + self.assertNotEqual(record[0], "mail.message") + + def test_emptying_default_thread(self): + """Choosing an ``object_id`` empties ``default_thread_id``.""" + self.assertEqual( + self.server.onchange_server_type(object_id=1) + ["value"]["default_thread_id"], + False) + + def test_emptying_object(self): + """Choosing a ``default_thread_id`` empties ``object_id``.""" + self.server.object_id = self.env["ir.model"].search([], limit=1) + self.server._onchange_remove_object_id() + self.assertFalse(self.server.object_id) + + @mute_logger('openerp.addons.mail.models.mail_thread', 'openerp.models') + def test_unbound_incoming_email(self): + """An unbound incoming email gets posted to the sink.""" + # Imitate what self.server.feth_mail() would do + result = ( + self.MailThread.with_context(fetchmail_server_id=self.server.id) + .message_process( + self.server.object_id.model, + MAIL_TEMPLATE.format( + email_from="spambot@example.com", + to="you@example.com", + cc="nobody@example.com", + subject="I'm a robot, hello", + extra="", + msg_id="", + ), + save_original=self.server.original, + strip_attachments=not self.server.attach, + ) + ) + self.assertEqual(self.server.default_thread_id, self.sink) + self.assertEqual(result, self.sink.id) + # Nobody subscribed + self.assertFalse(self.sink.message_partner_ids) + # Message entered channel + self.assertEqual(self.sink.message_ids.subject, "I'm a robot, hello") diff --git a/fetchmail_thread_default/views/fetchmail_server_view.xml b/fetchmail_thread_default/views/fetchmail_server_view.xml new file mode 100644 index 00000000..05422f13 --- /dev/null +++ b/fetchmail_thread_default/views/fetchmail_server_view.xml @@ -0,0 +1,18 @@ + + + + + + + Add default thread + fetchmail.server + + + + + + + + +