OCA-git-bot
4 years ago
17 changed files with 1013 additions and 0 deletions
-
99partner_email_check/README.rst
-
3partner_email_check/__init__.py
-
21partner_email_check/__manifest__.py
-
84partner_email_check/i18n/partner_email_check.pot
-
4partner_email_check/models/__init__.py
-
42partner_email_check/models/res_config_settings.py
-
95partner_email_check/models/res_partner.py
-
9partner_email_check/readme/CONFIGURE.rst
-
2partner_email_check/readme/CONTRIBUTORS.rst
-
8partner_email_check/readme/DESCRIPTION.rst
-
1partner_email_check/readme/USAGE.rst
-
BINpartner_email_check/static/description/icon.png
-
441partner_email_check/static/description/index.html
-
3partner_email_check/tests/__init__.py
-
161partner_email_check/tests/test_partner_email_check.py
-
39partner_email_check/views/base_config_view.xml
-
1requirements.txt
@ -0,0 +1,99 @@ |
|||||
|
==================== |
||||
|
Email Format Checker |
||||
|
==================== |
||||
|
|
||||
|
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
||||
|
!! This file is generated by oca-gen-addon-readme !! |
||||
|
!! changes will be overwritten. !! |
||||
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
||||
|
|
||||
|
.. |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%2Fpartner--contact-lightgray.png?logo=github |
||||
|
:target: https://github.com/OCA/partner-contact/tree/12.0/partner_email_check |
||||
|
:alt: OCA/partner-contact |
||||
|
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png |
||||
|
:target: https://translation.odoo-community.org/projects/partner-contact-12-0/partner-contact-12-0-partner_email_check |
||||
|
:alt: Translate me on Weblate |
||||
|
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png |
||||
|
:target: https://runbot.odoo-community.org/runbot/134/12.0 |
||||
|
:alt: Try me on Runbot |
||||
|
|
||||
|
|badge1| |badge2| |badge3| |badge4| |badge5| |
||||
|
|
||||
|
This module validates and normalizes the field ``email`` in the model |
||||
|
``res.partner``. |
||||
|
|
||||
|
As part of the normalization, email addresses are converted to lowercase. |
||||
|
|
||||
|
Optionally, multiple partners can not be allowed to have the same address. |
||||
|
This will not work with multiple comma-separated email addresses in the field, |
||||
|
although validation and normalization are still supported in such cases. |
||||
|
|
||||
|
**Table of contents** |
||||
|
|
||||
|
.. contents:: |
||||
|
:local: |
||||
|
|
||||
|
Configuration |
||||
|
============= |
||||
|
|
||||
|
Install python package email-validator: ``sudo pip install email-validator``. |
||||
|
|
||||
|
To not allow multiple partners to have the same email address, use the |
||||
|
"Filter duplicate email addresses"/``partner_email_check_filter_duplicates`` |
||||
|
setting. |
||||
|
|
||||
|
To validate that email addresses are deliverable (that the hostname exists), |
||||
|
use the "Check deliverability of email addresses"/``partner_email_check_check_deliverability`` |
||||
|
setting. |
||||
|
|
||||
|
Usage |
||||
|
===== |
||||
|
|
||||
|
This module integrate automatically in all of the view ``res.partner`` |
||||
|
|
||||
|
Bug Tracker |
||||
|
=========== |
||||
|
|
||||
|
Bugs are tracked on `GitHub Issues <https://github.com/OCA/partner-contact/issues>`_. |
||||
|
In case of trouble, please check there if your issue has already been reported. |
||||
|
If you spotted it first, help us smashing it by providing a detailed and welcomed |
||||
|
`feedback <https://github.com/OCA/partner-contact/issues/new?body=module:%20partner_email_check%0Aversion:%2012.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 |
||||
|
~~~~~~~ |
||||
|
|
||||
|
* Komit |
||||
|
|
||||
|
Contributors |
||||
|
~~~~~~~~~~~~ |
||||
|
|
||||
|
* Vo Hoang Dat <dat.vh@komit-consulting.com> |
||||
|
* Jean-Charles Drubay <jc@komit-consulting.com> |
||||
|
|
||||
|
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/partner-contact <https://github.com/OCA/partner-contact/tree/12.0/partner_email_check>`_ project on GitHub. |
||||
|
|
||||
|
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. |
||||
@ -0,0 +1,3 @@ |
|||||
|
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). |
||||
|
|
||||
|
from . import models |
||||
@ -0,0 +1,21 @@ |
|||||
|
# Copyright 2019 Komit <https://komit-consulting.com> |
||||
|
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). |
||||
|
|
||||
|
{ |
||||
|
'name': 'Email Format Checker', |
||||
|
'version': '12.0.1.0.0', |
||||
|
'summary': 'Validate email address field', |
||||
|
'author': "Komit, Odoo Community Association (OCA)", |
||||
|
'website': 'https://github.com/OCA/partner-contact', |
||||
|
'category': 'Tools', |
||||
|
'depends': ['base_setup'], |
||||
|
'installable': True, |
||||
|
'application': False, |
||||
|
'license': 'AGPL-3', |
||||
|
'external_dependencies': { |
||||
|
'python': ['email_validator'] |
||||
|
}, |
||||
|
'data': [ |
||||
|
'views/base_config_view.xml', |
||||
|
] |
||||
|
} |
||||
@ -0,0 +1,84 @@ |
|||||
|
# Translation of Odoo Server. |
||||
|
# This file contains the translation of the following modules: |
||||
|
# * partner_email_check |
||||
|
# |
||||
|
msgid "" |
||||
|
msgstr "" |
||||
|
"Project-Id-Version: Odoo Server 11.0\n" |
||||
|
"Report-Msgid-Bugs-To: \n" |
||||
|
"Last-Translator: <>\n" |
||||
|
"Language-Team: \n" |
||||
|
"MIME-Version: 1.0\n" |
||||
|
"Content-Type: text/plain; charset=UTF-8\n" |
||||
|
"Content-Transfer-Encoding: \n" |
||||
|
"Plural-Forms: \n" |
||||
|
|
||||
|
#. module: partner_email_check |
||||
|
#: code:addons/partner_email_check/models/res_partner.py:65 |
||||
|
#, python-format |
||||
|
msgid "%s is an invalid email" |
||||
|
msgstr "" |
||||
|
|
||||
|
#. module: partner_email_check |
||||
|
#: code:addons/partner_email_check/models/res_partner.py:69 |
||||
|
#, python-format |
||||
|
msgid "Cannot deliver to email address %s" |
||||
|
msgstr "" |
||||
|
|
||||
|
#. module: partner_email_check |
||||
|
#: model:ir.model.fields,field_description:partner_email_check.field_res_config_settings_partner_email_check_check_deliverability |
||||
|
msgid "Check deliverability of email addresses" |
||||
|
msgstr "" |
||||
|
|
||||
|
#. module: partner_email_check |
||||
|
#: model:ir.model,name:partner_email_check.model_res_partner |
||||
|
msgid "Contact" |
||||
|
msgstr "" |
||||
|
|
||||
|
#. module: partner_email_check |
||||
|
#: model:ir.model.fields,help:partner_email_check.field_res_config_settings_partner_email_check_check_deliverability |
||||
|
msgid "Don't allow email addresses with providers that don't exist" |
||||
|
msgstr "" |
||||
|
|
||||
|
#. module: partner_email_check |
||||
|
#: model:ir.model.fields,help:partner_email_check.field_res_config_settings_partner_email_check_filter_duplicates |
||||
|
msgid "Don't allow multiple partners to have the same email address." |
||||
|
msgstr "" |
||||
|
|
||||
|
#. module: partner_email_check |
||||
|
#: code:addons/partner_email_check/models/res_partner.py:48 |
||||
|
#, python-format |
||||
|
msgid "Email '%s' is already in use." |
||||
|
msgstr "" |
||||
|
|
||||
|
#. module: partner_email_check |
||||
|
#: model:ir.ui.view,arch_db:partner_email_check.view_general_configuration |
||||
|
msgid "Email validation" |
||||
|
msgstr "" |
||||
|
|
||||
|
#. module: partner_email_check |
||||
|
#: model:ir.ui.view,arch_db:partner_email_check.view_general_configuration |
||||
|
msgid "Ensure that partner email addresses can be delivered to" |
||||
|
msgstr "" |
||||
|
|
||||
|
#. module: partner_email_check |
||||
|
#: code:addons/partner_email_check/models/res_partner.py:40 |
||||
|
#, python-format |
||||
|
msgid "Field contains multiple email addresses. This is not supported when duplicate email addresses are not allowed." |
||||
|
msgstr "" |
||||
|
|
||||
|
#. module: partner_email_check |
||||
|
#: model:ir.model.fields,field_description:partner_email_check.field_res_config_settings_partner_email_check_filter_duplicates |
||||
|
msgid "Filter duplicate partner email addresses" |
||||
|
msgstr "" |
||||
|
|
||||
|
#. module: partner_email_check |
||||
|
#: model:ir.ui.view,arch_db:partner_email_check.view_general_configuration |
||||
|
msgid "Require partner email addresses to be unique" |
||||
|
msgstr "" |
||||
|
|
||||
|
#. module: partner_email_check |
||||
|
#: model:ir.model,name:partner_email_check.model_res_config_settings |
||||
|
msgid "res.config.settings" |
||||
|
msgstr "" |
||||
|
|
||||
@ -0,0 +1,4 @@ |
|||||
|
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). |
||||
|
|
||||
|
from . import res_config_settings |
||||
|
from . import res_partner |
||||
@ -0,0 +1,42 @@ |
|||||
|
from odoo import api, fields, models |
||||
|
|
||||
|
|
||||
|
class ResConfigSettings(models.TransientModel): |
||||
|
_inherit = 'res.config.settings' |
||||
|
|
||||
|
partner_email_check_filter_duplicates = fields.Boolean( |
||||
|
string="Filter duplicate partner email addresses", |
||||
|
help="Don't allow multiple partners to have the same email address.", |
||||
|
) |
||||
|
|
||||
|
partner_email_check_check_deliverability = fields.Boolean( |
||||
|
string="Check deliverability of email addresses", |
||||
|
help="Don't allow email addresses with providers that don't exist", |
||||
|
) |
||||
|
|
||||
|
@api.model |
||||
|
def get_values(self): |
||||
|
res = super(ResConfigSettings, self).get_values() |
||||
|
conf = self.env['ir.config_parameter'].sudo() |
||||
|
res.update( |
||||
|
partner_email_check_filter_duplicates=conf.get_param( |
||||
|
'partner_email_check_filter_duplicates', 'False' |
||||
|
) == 'True', |
||||
|
partner_email_check_check_deliverability=conf.get_param( |
||||
|
'partner_email_check_check_deliverability', 'False' |
||||
|
) == 'True', |
||||
|
) |
||||
|
return res |
||||
|
|
||||
|
@api.multi |
||||
|
def set_values(self): |
||||
|
super(ResConfigSettings, self).set_values() |
||||
|
conf = self.env['ir.config_parameter'].sudo() |
||||
|
conf.set_param( |
||||
|
'partner_email_check_filter_duplicates', |
||||
|
self.partner_email_check_filter_duplicates |
||||
|
) |
||||
|
conf.set_param( |
||||
|
'partner_email_check_check_deliverability', |
||||
|
self.partner_email_check_check_deliverability |
||||
|
) |
||||
@ -0,0 +1,95 @@ |
|||||
|
# Copyright 2019 Komit <https://komit-consulting.com> |
||||
|
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). |
||||
|
|
||||
|
import logging |
||||
|
from odoo import api, models, _ |
||||
|
from odoo.exceptions import UserError, ValidationError |
||||
|
from odoo.tools import config |
||||
|
|
||||
|
_logger = logging.getLogger(__name__) |
||||
|
|
||||
|
try: |
||||
|
from email_validator import ( |
||||
|
validate_email, |
||||
|
EmailSyntaxError, |
||||
|
EmailUndeliverableError, |
||||
|
) |
||||
|
except ImportError: |
||||
|
_logger.debug('Cannot import "email_validator".') |
||||
|
|
||||
|
validate_email = None |
||||
|
|
||||
|
|
||||
|
class ResPartner(models.Model): |
||||
|
_inherit = 'res.partner' |
||||
|
|
||||
|
@api.model |
||||
|
def email_check(self, emails): |
||||
|
if (config['test_enable'] and |
||||
|
not self.env.context.get('test_partner_email_check')): |
||||
|
return emails |
||||
|
return ','.join(self._normalize_email(email.strip()) |
||||
|
for email in emails.split(',')) |
||||
|
|
||||
|
@api.constrains('email') |
||||
|
def _check_email_unique(self): |
||||
|
if self._should_filter_duplicates(): |
||||
|
for rec in self.filtered("email"): |
||||
|
if ',' in rec.email: |
||||
|
raise UserError( |
||||
|
_("Field contains multiple email addresses. This is " |
||||
|
"not supported when duplicate email addresses are " |
||||
|
"not allowed.") |
||||
|
) |
||||
|
if self.search_count( |
||||
|
[('email', '=', rec.email), ('id', '!=', rec.id)] |
||||
|
): |
||||
|
raise UserError( |
||||
|
_("Email '%s' is already in use.") % rec.email.strip() |
||||
|
) |
||||
|
|
||||
|
def _normalize_email(self, email): |
||||
|
if validate_email is None: |
||||
|
_logger.warning( |
||||
|
'Can not validate email, ' |
||||
|
'python dependency required "email_validator"') |
||||
|
return email |
||||
|
|
||||
|
try: |
||||
|
result = validate_email( |
||||
|
email, |
||||
|
check_deliverability=self._should_check_deliverability(), |
||||
|
) |
||||
|
except EmailSyntaxError: |
||||
|
raise ValidationError( |
||||
|
_("%s is an invalid email") % email.strip() |
||||
|
) |
||||
|
except EmailUndeliverableError: |
||||
|
raise ValidationError( |
||||
|
_("Cannot deliver to email address %s") % email.strip() |
||||
|
) |
||||
|
return result['local'].lower() + '@' + result['domain_i18n'] |
||||
|
|
||||
|
def _should_filter_duplicates(self): |
||||
|
conf = self.env['ir.config_parameter'].sudo().get_param( |
||||
|
'partner_email_check_filter_duplicates', 'False' |
||||
|
) |
||||
|
return conf == 'True' |
||||
|
|
||||
|
def _should_check_deliverability(self): |
||||
|
conf = self.env['ir.config_parameter'].sudo().get_param( |
||||
|
'partner_email_check_check_deliverability', 'False' |
||||
|
) |
||||
|
return conf == 'True' |
||||
|
|
||||
|
@api.model |
||||
|
def create(self, vals): |
||||
|
if vals.get('email'): |
||||
|
vals['email'] = self.email_check(vals['email']) |
||||
|
return super(ResPartner, self).create(vals) |
||||
|
|
||||
|
@api.multi |
||||
|
def write(self, vals): |
||||
|
if vals.get('email'): |
||||
|
vals['email'] = self.email_check(vals['email']) |
||||
|
return super(ResPartner, self).write(vals) |
||||
@ -0,0 +1,9 @@ |
|||||
|
Install python package email-validator: ``sudo pip install email-validator``. |
||||
|
|
||||
|
To not allow multiple partners to have the same email address, use the |
||||
|
"Filter duplicate email addresses"/``partner_email_check_filter_duplicates`` |
||||
|
setting. |
||||
|
|
||||
|
To validate that email addresses are deliverable (that the hostname exists), |
||||
|
use the "Check deliverability of email addresses"/``partner_email_check_check_deliverability`` |
||||
|
setting. |
||||
@ -0,0 +1,2 @@ |
|||||
|
* Vo Hoang Dat <dat.vh@komit-consulting.com> |
||||
|
* Jean-Charles Drubay <jc@komit-consulting.com> |
||||
@ -0,0 +1,8 @@ |
|||||
|
This module validates and normalizes the field ``email`` in the model |
||||
|
``res.partner``. |
||||
|
|
||||
|
As part of the normalization, email addresses are converted to lowercase. |
||||
|
|
||||
|
Optionally, multiple partners can not be allowed to have the same address. |
||||
|
This will not work with multiple comma-separated email addresses in the field, |
||||
|
although validation and normalization are still supported in such cases. |
||||
@ -0,0 +1 @@ |
|||||
|
This module integrate automatically in all of the view ``res.partner`` |
||||
|
After Width: 128 | Height: 128 | Size: 9.2 KiB |
@ -0,0 +1,441 @@ |
|||||
|
<?xml version="1.0" encoding="utf-8" ?> |
||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
||||
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
||||
|
<head> |
||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
|
<meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" /> |
||||
|
<title>Email Format Checker</title> |
||||
|
<style type="text/css"> |
||||
|
|
||||
|
/* |
||||
|
:Author: David Goodger (goodger@python.org) |
||||
|
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $ |
||||
|
:Copyright: This stylesheet has been placed in the public domain. |
||||
|
|
||||
|
Default cascading style sheet for the HTML output of Docutils. |
||||
|
|
||||
|
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to |
||||
|
customize this style sheet. |
||||
|
*/ |
||||
|
|
||||
|
/* used to remove borders from tables and images */ |
||||
|
.borderless, table.borderless td, table.borderless th { |
||||
|
border: 0 } |
||||
|
|
||||
|
table.borderless td, table.borderless th { |
||||
|
/* Override padding for "table.docutils td" with "! important". |
||||
|
The right padding separates the table cells. */ |
||||
|
padding: 0 0.5em 0 0 ! important } |
||||
|
|
||||
|
.first { |
||||
|
/* Override more specific margin styles with "! important". */ |
||||
|
margin-top: 0 ! important } |
||||
|
|
||||
|
.last, .with-subtitle { |
||||
|
margin-bottom: 0 ! important } |
||||
|
|
||||
|
.hidden { |
||||
|
display: none } |
||||
|
|
||||
|
.subscript { |
||||
|
vertical-align: sub; |
||||
|
font-size: smaller } |
||||
|
|
||||
|
.superscript { |
||||
|
vertical-align: super; |
||||
|
font-size: smaller } |
||||
|
|
||||
|
a.toc-backref { |
||||
|
text-decoration: none ; |
||||
|
color: black } |
||||
|
|
||||
|
blockquote.epigraph { |
||||
|
margin: 2em 5em ; } |
||||
|
|
||||
|
dl.docutils dd { |
||||
|
margin-bottom: 0.5em } |
||||
|
|
||||
|
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] { |
||||
|
overflow: hidden; |
||||
|
} |
||||
|
|
||||
|
/* Uncomment (and remove this text!) to get bold-faced definition list terms |
||||
|
dl.docutils dt { |
||||
|
font-weight: bold } |
||||
|
*/ |
||||
|
|
||||
|
div.abstract { |
||||
|
margin: 2em 5em } |
||||
|
|
||||
|
div.abstract p.topic-title { |
||||
|
font-weight: bold ; |
||||
|
text-align: center } |
||||
|
|
||||
|
div.admonition, div.attention, div.caution, div.danger, div.error, |
||||
|
div.hint, div.important, div.note, div.tip, div.warning { |
||||
|
margin: 2em ; |
||||
|
border: medium outset ; |
||||
|
padding: 1em } |
||||
|
|
||||
|
div.admonition p.admonition-title, div.hint p.admonition-title, |
||||
|
div.important p.admonition-title, div.note p.admonition-title, |
||||
|
div.tip p.admonition-title { |
||||
|
font-weight: bold ; |
||||
|
font-family: sans-serif } |
||||
|
|
||||
|
div.attention p.admonition-title, div.caution p.admonition-title, |
||||
|
div.danger p.admonition-title, div.error p.admonition-title, |
||||
|
div.warning p.admonition-title, .code .error { |
||||
|
color: red ; |
||||
|
font-weight: bold ; |
||||
|
font-family: sans-serif } |
||||
|
|
||||
|
/* Uncomment (and remove this text!) to get reduced vertical space in |
||||
|
compound paragraphs. |
||||
|
div.compound .compound-first, div.compound .compound-middle { |
||||
|
margin-bottom: 0.5em } |
||||
|
|
||||
|
div.compound .compound-last, div.compound .compound-middle { |
||||
|
margin-top: 0.5em } |
||||
|
*/ |
||||
|
|
||||
|
div.dedication { |
||||
|
margin: 2em 5em ; |
||||
|
text-align: center ; |
||||
|
font-style: italic } |
||||
|
|
||||
|
div.dedication p.topic-title { |
||||
|
font-weight: bold ; |
||||
|
font-style: normal } |
||||
|
|
||||
|
div.figure { |
||||
|
margin-left: 2em ; |
||||
|
margin-right: 2em } |
||||
|
|
||||
|
div.footer, div.header { |
||||
|
clear: both; |
||||
|
font-size: smaller } |
||||
|
|
||||
|
div.line-block { |
||||
|
display: block ; |
||||
|
margin-top: 1em ; |
||||
|
margin-bottom: 1em } |
||||
|
|
||||
|
div.line-block div.line-block { |
||||
|
margin-top: 0 ; |
||||
|
margin-bottom: 0 ; |
||||
|
margin-left: 1.5em } |
||||
|
|
||||
|
div.sidebar { |
||||
|
margin: 0 0 0.5em 1em ; |
||||
|
border: medium outset ; |
||||
|
padding: 1em ; |
||||
|
background-color: #ffffee ; |
||||
|
width: 40% ; |
||||
|
float: right ; |
||||
|
clear: right } |
||||
|
|
||||
|
div.sidebar p.rubric { |
||||
|
font-family: sans-serif ; |
||||
|
font-size: medium } |
||||
|
|
||||
|
div.system-messages { |
||||
|
margin: 5em } |
||||
|
|
||||
|
div.system-messages h1 { |
||||
|
color: red } |
||||
|
|
||||
|
div.system-message { |
||||
|
border: medium outset ; |
||||
|
padding: 1em } |
||||
|
|
||||
|
div.system-message p.system-message-title { |
||||
|
color: red ; |
||||
|
font-weight: bold } |
||||
|
|
||||
|
div.topic { |
||||
|
margin: 2em } |
||||
|
|
||||
|
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle, |
||||
|
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle { |
||||
|
margin-top: 0.4em } |
||||
|
|
||||
|
h1.title { |
||||
|
text-align: center } |
||||
|
|
||||
|
h2.subtitle { |
||||
|
text-align: center } |
||||
|
|
||||
|
hr.docutils { |
||||
|
width: 75% } |
||||
|
|
||||
|
img.align-left, .figure.align-left, object.align-left, table.align-left { |
||||
|
clear: left ; |
||||
|
float: left ; |
||||
|
margin-right: 1em } |
||||
|
|
||||
|
img.align-right, .figure.align-right, object.align-right, table.align-right { |
||||
|
clear: right ; |
||||
|
float: right ; |
||||
|
margin-left: 1em } |
||||
|
|
||||
|
img.align-center, .figure.align-center, object.align-center { |
||||
|
display: block; |
||||
|
margin-left: auto; |
||||
|
margin-right: auto; |
||||
|
} |
||||
|
|
||||
|
table.align-center { |
||||
|
margin-left: auto; |
||||
|
margin-right: auto; |
||||
|
} |
||||
|
|
||||
|
.align-left { |
||||
|
text-align: left } |
||||
|
|
||||
|
.align-center { |
||||
|
clear: both ; |
||||
|
text-align: center } |
||||
|
|
||||
|
.align-right { |
||||
|
text-align: right } |
||||
|
|
||||
|
/* reset inner alignment in figures */ |
||||
|
div.align-right { |
||||
|
text-align: inherit } |
||||
|
|
||||
|
/* div.align-center * { */ |
||||
|
/* text-align: left } */ |
||||
|
|
||||
|
.align-top { |
||||
|
vertical-align: top } |
||||
|
|
||||
|
.align-middle { |
||||
|
vertical-align: middle } |
||||
|
|
||||
|
.align-bottom { |
||||
|
vertical-align: bottom } |
||||
|
|
||||
|
ol.simple, ul.simple { |
||||
|
margin-bottom: 1em } |
||||
|
|
||||
|
ol.arabic { |
||||
|
list-style: decimal } |
||||
|
|
||||
|
ol.loweralpha { |
||||
|
list-style: lower-alpha } |
||||
|
|
||||
|
ol.upperalpha { |
||||
|
list-style: upper-alpha } |
||||
|
|
||||
|
ol.lowerroman { |
||||
|
list-style: lower-roman } |
||||
|
|
||||
|
ol.upperroman { |
||||
|
list-style: upper-roman } |
||||
|
|
||||
|
p.attribution { |
||||
|
text-align: right ; |
||||
|
margin-left: 50% } |
||||
|
|
||||
|
p.caption { |
||||
|
font-style: italic } |
||||
|
|
||||
|
p.credits { |
||||
|
font-style: italic ; |
||||
|
font-size: smaller } |
||||
|
|
||||
|
p.label { |
||||
|
white-space: nowrap } |
||||
|
|
||||
|
p.rubric { |
||||
|
font-weight: bold ; |
||||
|
font-size: larger ; |
||||
|
color: maroon ; |
||||
|
text-align: center } |
||||
|
|
||||
|
p.sidebar-title { |
||||
|
font-family: sans-serif ; |
||||
|
font-weight: bold ; |
||||
|
font-size: larger } |
||||
|
|
||||
|
p.sidebar-subtitle { |
||||
|
font-family: sans-serif ; |
||||
|
font-weight: bold } |
||||
|
|
||||
|
p.topic-title { |
||||
|
font-weight: bold } |
||||
|
|
||||
|
pre.address { |
||||
|
margin-bottom: 0 ; |
||||
|
margin-top: 0 ; |
||||
|
font: inherit } |
||||
|
|
||||
|
pre.literal-block, pre.doctest-block, pre.math, pre.code { |
||||
|
margin-left: 2em ; |
||||
|
margin-right: 2em } |
||||
|
|
||||
|
pre.code .ln { color: grey; } /* line numbers */ |
||||
|
pre.code, code { background-color: #eeeeee } |
||||
|
pre.code .comment, code .comment { color: #5C6576 } |
||||
|
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold } |
||||
|
pre.code .literal.string, code .literal.string { color: #0C5404 } |
||||
|
pre.code .name.builtin, code .name.builtin { color: #352B84 } |
||||
|
pre.code .deleted, code .deleted { background-color: #DEB0A1} |
||||
|
pre.code .inserted, code .inserted { background-color: #A3D289} |
||||
|
|
||||
|
span.classifier { |
||||
|
font-family: sans-serif ; |
||||
|
font-style: oblique } |
||||
|
|
||||
|
span.classifier-delimiter { |
||||
|
font-family: sans-serif ; |
||||
|
font-weight: bold } |
||||
|
|
||||
|
span.interpreted { |
||||
|
font-family: sans-serif } |
||||
|
|
||||
|
span.option { |
||||
|
white-space: nowrap } |
||||
|
|
||||
|
span.pre { |
||||
|
white-space: pre } |
||||
|
|
||||
|
span.problematic { |
||||
|
color: red } |
||||
|
|
||||
|
span.section-subtitle { |
||||
|
/* font-size relative to parent (h1..h6 element) */ |
||||
|
font-size: 80% } |
||||
|
|
||||
|
table.citation { |
||||
|
border-left: solid 1px gray; |
||||
|
margin-left: 1px } |
||||
|
|
||||
|
table.docinfo { |
||||
|
margin: 2em 4em } |
||||
|
|
||||
|
table.docutils { |
||||
|
margin-top: 0.5em ; |
||||
|
margin-bottom: 0.5em } |
||||
|
|
||||
|
table.footnote { |
||||
|
border-left: solid 1px black; |
||||
|
margin-left: 1px } |
||||
|
|
||||
|
table.docutils td, table.docutils th, |
||||
|
table.docinfo td, table.docinfo th { |
||||
|
padding-left: 0.5em ; |
||||
|
padding-right: 0.5em ; |
||||
|
vertical-align: top } |
||||
|
|
||||
|
table.docutils th.field-name, table.docinfo th.docinfo-name { |
||||
|
font-weight: bold ; |
||||
|
text-align: left ; |
||||
|
white-space: nowrap ; |
||||
|
padding-left: 0 } |
||||
|
|
||||
|
/* "booktabs" style (no vertical lines) */ |
||||
|
table.docutils.booktabs { |
||||
|
border: 0px; |
||||
|
border-top: 2px solid; |
||||
|
border-bottom: 2px solid; |
||||
|
border-collapse: collapse; |
||||
|
} |
||||
|
table.docutils.booktabs * { |
||||
|
border: 0px; |
||||
|
} |
||||
|
table.docutils.booktabs th { |
||||
|
border-bottom: thin solid; |
||||
|
text-align: left; |
||||
|
} |
||||
|
|
||||
|
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils, |
||||
|
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils { |
||||
|
font-size: 100% } |
||||
|
|
||||
|
ul.auto-toc { |
||||
|
list-style-type: none } |
||||
|
|
||||
|
</style> |
||||
|
</head> |
||||
|
<body> |
||||
|
<div class="document" id="email-format-checker"> |
||||
|
<h1 class="title">Email Format Checker</h1> |
||||
|
|
||||
|
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
||||
|
!! This file is generated by oca-gen-addon-readme !! |
||||
|
!! changes will be overwritten. !! |
||||
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> |
||||
|
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/partner-contact/tree/12.0/partner_email_check"><img alt="OCA/partner-contact" src="https://img.shields.io/badge/github-OCA%2Fpartner--contact-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/partner-contact-12-0/partner-contact-12-0-partner_email_check"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/134/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p> |
||||
|
<p>This module validates and normalizes the field <tt class="docutils literal">email</tt> in the model |
||||
|
<tt class="docutils literal">res.partner</tt>.</p> |
||||
|
<p>As part of the normalization, email addresses are converted to lowercase.</p> |
||||
|
<p>Optionally, multiple partners can not be allowed to have the same address. |
||||
|
This will not work with multiple comma-separated email addresses in the field, |
||||
|
although validation and normalization are still supported in such cases.</p> |
||||
|
<p><strong>Table of contents</strong></p> |
||||
|
<div class="contents local topic" id="contents"> |
||||
|
<ul class="simple"> |
||||
|
<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li> |
||||
|
<li><a class="reference internal" href="#usage" id="id2">Usage</a></li> |
||||
|
<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li> |
||||
|
<li><a class="reference internal" href="#credits" id="id4">Credits</a><ul> |
||||
|
<li><a class="reference internal" href="#authors" id="id5">Authors</a></li> |
||||
|
<li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li> |
||||
|
<li><a class="reference internal" href="#maintainers" id="id7">Maintainers</a></li> |
||||
|
</ul> |
||||
|
</li> |
||||
|
</ul> |
||||
|
</div> |
||||
|
<div class="section" id="configuration"> |
||||
|
<h1><a class="toc-backref" href="#id1">Configuration</a></h1> |
||||
|
<p>Install python package email-validator: <tt class="docutils literal">sudo pip install <span class="pre">email-validator</span></tt>.</p> |
||||
|
<p>To not allow multiple partners to have the same email address, use the |
||||
|
“Filter duplicate email addresses”/<tt class="docutils literal">partner_email_check_filter_duplicates</tt> |
||||
|
setting.</p> |
||||
|
<p>To validate that email addresses are deliverable (that the hostname exists), |
||||
|
use the “Check deliverability of email addresses”/<tt class="docutils literal">partner_email_check_check_deliverability</tt> |
||||
|
setting.</p> |
||||
|
</div> |
||||
|
<div class="section" id="usage"> |
||||
|
<h1><a class="toc-backref" href="#id2">Usage</a></h1> |
||||
|
<p>This module integrate automatically in all of the view <tt class="docutils literal">res.partner</tt></p> |
||||
|
</div> |
||||
|
<div class="section" id="bug-tracker"> |
||||
|
<h1><a class="toc-backref" href="#id3">Bug Tracker</a></h1> |
||||
|
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/partner-contact/issues">GitHub Issues</a>. |
||||
|
In case of trouble, please check there if your issue has already been reported. |
||||
|
If you spotted it first, help us smashing it by providing a detailed and welcomed |
||||
|
<a class="reference external" href="https://github.com/OCA/partner-contact/issues/new?body=module:%20partner_email_check%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p> |
||||
|
<p>Do not contact contributors directly about support or help with technical issues.</p> |
||||
|
</div> |
||||
|
<div class="section" id="credits"> |
||||
|
<h1><a class="toc-backref" href="#id4">Credits</a></h1> |
||||
|
<div class="section" id="authors"> |
||||
|
<h2><a class="toc-backref" href="#id5">Authors</a></h2> |
||||
|
<ul class="simple"> |
||||
|
<li>Komit</li> |
||||
|
</ul> |
||||
|
</div> |
||||
|
<div class="section" id="contributors"> |
||||
|
<h2><a class="toc-backref" href="#id6">Contributors</a></h2> |
||||
|
<ul class="simple"> |
||||
|
<li>Vo Hoang Dat <<a class="reference external" href="mailto:dat.vh@komit-consulting.com">dat.vh@komit-consulting.com</a>></li> |
||||
|
<li>Jean-Charles Drubay <<a class="reference external" href="mailto:jc@komit-consulting.com">jc@komit-consulting.com</a>></li> |
||||
|
</ul> |
||||
|
</div> |
||||
|
<div class="section" id="maintainers"> |
||||
|
<h2><a class="toc-backref" href="#id7">Maintainers</a></h2> |
||||
|
<p>This module is maintained by the OCA.</p> |
||||
|
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a> |
||||
|
<p>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.</p> |
||||
|
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/partner-contact/tree/12.0/partner_email_check">OCA/partner-contact</a> project on GitHub.</p> |
||||
|
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p> |
||||
|
</div> |
||||
|
</div> |
||||
|
</div> |
||||
|
</body> |
||||
|
</html> |
||||
@ -0,0 +1,3 @@ |
|||||
|
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). |
||||
|
|
||||
|
from . import test_partner_email_check |
||||
@ -0,0 +1,161 @@ |
|||||
|
# Copyright 2019 Komit <https://komit-consulting.com> |
||||
|
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). |
||||
|
|
||||
|
from unittest.mock import patch |
||||
|
|
||||
|
from odoo.exceptions import ValidationError |
||||
|
from odoo.tests.common import TransactionCase |
||||
|
from odoo.tools.misc import mute_logger |
||||
|
|
||||
|
|
||||
|
class TestPartnerEmailCheck(TransactionCase): |
||||
|
def setUp(self): |
||||
|
super(TestPartnerEmailCheck, self).setUp() |
||||
|
# Checks are disabled during tests unless this key is set |
||||
|
self.res_partner = self.env['res.partner'].with_context( |
||||
|
test_partner_email_check=True |
||||
|
) |
||||
|
self.test_partner = self.res_partner.create({ |
||||
|
'name': 'test', |
||||
|
}) |
||||
|
self.wizard = self.env['res.config.settings'].create({}) |
||||
|
self.wizard.partner_email_check_filter_duplicates = False |
||||
|
self.wizard.partner_email_check_check_deliverability = False |
||||
|
self.wizard.set_values() |
||||
|
|
||||
|
def test_bad_email(self): |
||||
|
"""Test rejection of bad emails.""" |
||||
|
with self.assertRaises(ValidationError): |
||||
|
self.test_partner.email = 'bad@email@domain..com' |
||||
|
|
||||
|
def test_good_email(self): |
||||
|
"""Test acceptance of good""" |
||||
|
self.test_partner.email = 'goodemail@domain.com' |
||||
|
self.assertTrue(self.test_partner.email) |
||||
|
|
||||
|
def test_bad_emails(self): |
||||
|
"""Test rejection of bad emails.""" |
||||
|
with self.assertRaises(ValidationError): |
||||
|
self.test_partner.email = 'good@domain.com,bad@email@domain..com' |
||||
|
|
||||
|
def test_good_emails(self): |
||||
|
"""Test acceptance of good""" |
||||
|
self.test_partner.email = 'goodemail@domain.com,goodemail2@domain.com' |
||||
|
self.assertTrue(self.test_partner.email) |
||||
|
|
||||
|
def test_email_domain_normalization(self): |
||||
|
"""Test normalization of email domain names, including punycode.""" |
||||
|
self.test_partner.write({'email': 'goodemail@xn--xamPle-9ua.com'}) |
||||
|
self.assertEqual(self.test_partner.email, u'goodemail@éxample.com') |
||||
|
|
||||
|
def test_multi_email_domain_normalization(self): |
||||
|
"""Test normalization of email domain names of multiple addresses.""" |
||||
|
self.test_partner.write({ |
||||
|
'email': 'goodemail@doMAIN.com,othergood@xn--xample-9ua.com' |
||||
|
}) |
||||
|
self.assertEqual( |
||||
|
self.test_partner.email, |
||||
|
u'goodemail@domain.com,othergood@éxample.com' |
||||
|
) |
||||
|
|
||||
|
def test_email_local_normalization(self): |
||||
|
"""Test normalization of the local part of email addresses.""" |
||||
|
self.test_partner.write({'email': 'Me@mail.org'}) |
||||
|
# .lower() is locale-dependent, so don't hardcode the result |
||||
|
self.assertEqual(self.test_partner.email, 'Me'.lower() + '@mail.org') |
||||
|
|
||||
|
def test_multi_email_local_normalization(self): |
||||
|
"""Test normalization of the local part of multiple addresses.""" |
||||
|
self.test_partner.write({'email': 'You@mAiL.net,mE@mail.com'}) |
||||
|
self.assertEqual( |
||||
|
self.test_partner.email, |
||||
|
'You'.lower() + '@mail.net,' + 'mE'.lower() + '@mail.com' |
||||
|
) |
||||
|
|
||||
|
def disallow_duplicates(self): |
||||
|
self.wizard.partner_email_check_filter_duplicates = True |
||||
|
self.wizard.set_values() |
||||
|
|
||||
|
def test_duplicate_addresses_disallowed(self): |
||||
|
self.disallow_duplicates() |
||||
|
self.test_partner.write({'email': 'email@domain.tld'}) |
||||
|
with self.assertRaises(ValidationError): |
||||
|
self.res_partner.create({ |
||||
|
'name': 'alsotest', |
||||
|
'email': 'email@domain.tld' |
||||
|
}) |
||||
|
|
||||
|
def test_duplicate_after_normalization_addresses_disallowed(self): |
||||
|
self.disallow_duplicates() |
||||
|
self.res_partner.create({ |
||||
|
'name': 'alsotest', |
||||
|
'email': 'email@doMAIN.tld' |
||||
|
}) |
||||
|
with self.assertRaises(ValidationError): |
||||
|
self.test_partner.email = 'email@domain.tld' |
||||
|
|
||||
|
def test_multiple_addresses_disallowed_when_duplicates_filtered(self): |
||||
|
self.disallow_duplicates() |
||||
|
with self.assertRaises(ValidationError): |
||||
|
self.test_partner.email = 'foo@bar.org,email@domain.tld' |
||||
|
|
||||
|
def test_duplicate_addresses_allowed_by_default(self): |
||||
|
self.res_partner.create({ |
||||
|
'name': 'alsotest', |
||||
|
'email': 'email@domain.tld', |
||||
|
}) |
||||
|
self.test_partner.email = 'email@domain.tld' |
||||
|
|
||||
|
def check_deliverability(self): |
||||
|
self.wizard.partner_email_check_check_deliverability = True |
||||
|
self.wizard.set_values() |
||||
|
|
||||
|
def test_deliverable_addresses_allowed(self): |
||||
|
self.check_deliverability() |
||||
|
# We only need a resolving domain, not a real user |
||||
|
self.test_partner.email = 'gooddomain-icraglusrk@gmail.com' |
||||
|
self.assertTrue(self.test_partner.email) |
||||
|
|
||||
|
def test_nondeliverable_addresses_not_allowed(self): |
||||
|
self.check_deliverability() |
||||
|
with self.assertRaises(ValidationError): |
||||
|
# This domain may resolve by mistake on certain network setups |
||||
|
# At least until a new version of email-validator is released |
||||
|
# See https://github.com/JoshData/python-email-validator/pull/30 |
||||
|
self.test_partner.email = 'cezrik@acoa.nrdkt' |
||||
|
|
||||
|
def test_config_getters(self): |
||||
|
other_wizard = self.env['res.config.settings'].create({}) |
||||
|
self.assertFalse(other_wizard.partner_email_check_check_deliverability) |
||||
|
self.assertFalse(other_wizard.partner_email_check_filter_duplicates) |
||||
|
self.disallow_duplicates() |
||||
|
self.check_deliverability() |
||||
|
other_wizard = self.env['res.config.settings'].create({}) |
||||
|
self.assertTrue(other_wizard.partner_email_check_check_deliverability) |
||||
|
self.assertTrue(other_wizard.partner_email_check_filter_duplicates) |
||||
|
|
||||
|
@mute_logger('odoo.addons.partner_email_check.models.res_partner') |
||||
|
def test_lacking_dependency_does_not_halt_execution(self): |
||||
|
with patch('odoo.addons.partner_email_check.models.res_partner.' |
||||
|
'validate_email', None): |
||||
|
self.test_partner.email = 'notatallvalid@@domain' |
||||
|
|
||||
|
@mute_logger('odoo.addons.partner_email_check.models.res_partner') |
||||
|
def test_lacking_dependency_keeps_uniqueness_constraint_working(self): |
||||
|
self.disallow_duplicates() |
||||
|
with patch('odoo.addons.partner_email_check.models.res_partner.' |
||||
|
'validate_email', None): |
||||
|
self.res_partner.create({ |
||||
|
'name': 'alsotest', |
||||
|
'email': 'email@domain.tld' |
||||
|
}) |
||||
|
with self.assertRaises(ValidationError): |
||||
|
self.test_partner.email = 'email@domain.tld' |
||||
|
|
||||
|
def test_invalid_email_addresses_allowed_during_tests(self): |
||||
|
# Note: testing without test_partner_email_check in the context |
||||
|
new_partner = self.env['res.partner'].create({ |
||||
|
'name': 'invalidly emailed', |
||||
|
'email': 'invalid' |
||||
|
}) |
||||
|
self.assertEqual('invalid', new_partner.email) |
||||
@ -0,0 +1,39 @@ |
|||||
|
<?xml version="1.0" encoding="utf-8"?> |
||||
|
<odoo> |
||||
|
<record id="view_general_configuration" model="ir.ui.view"> |
||||
|
<field name="name">partner_email_check</field> |
||||
|
<field name="model">res.config.settings</field> |
||||
|
<field name="inherit_id" |
||||
|
ref="base_setup.res_config_settings_view_form" /> |
||||
|
<field name="arch" type="xml"> |
||||
|
<xpath expr="//div[@name='multi_company']" position='after'> |
||||
|
<h2>Email validation</h2> |
||||
|
<div class="row mt16 o_settings_container" |
||||
|
name="partner_email_check"> |
||||
|
<div class="col-xs-12 col-md-6 o_setting_box"> |
||||
|
<div class="o_setting_left_pane"> |
||||
|
<field name="partner_email_check_filter_duplicates" /> |
||||
|
</div> |
||||
|
<div class="o_setting_right_pane"> |
||||
|
<label for="partner_email_check_filter_duplicates" /> |
||||
|
<div class="text-muted"> |
||||
|
Require partner email addresses to be unique |
||||
|
</div> |
||||
|
</div> |
||||
|
</div> |
||||
|
<div class="col-xs-12 col-md-6 o_setting_box"> |
||||
|
<div class="o_setting_left_pane"> |
||||
|
<field name="partner_email_check_check_deliverability" /> |
||||
|
</div> |
||||
|
<div class="o_setting_right_pane"> |
||||
|
<label for="partner_email_check_check_deliverability" /> |
||||
|
<div class="text-muted"> |
||||
|
Ensure that partner email addresses can be delivered to |
||||
|
</div> |
||||
|
</div> |
||||
|
</div> |
||||
|
</div> |
||||
|
</xpath> |
||||
|
</field> |
||||
|
</record> |
||||
|
</odoo> |
||||
@ -0,0 +1 @@ |
|||||
|
email_validator |
||||
Write
Preview
Loading…
Cancel
Save
Reference in new issue