You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

99 lines
3.5 KiB

  1. ====================
  2. Email Format Checker
  3. ====================
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fpartner--contact-lightgray.png?logo=github
  15. :target: https://github.com/OCA/partner-contact/tree/14.0/partner_email_check
  16. :alt: OCA/partner-contact
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/partner-contact-14-0/partner-contact-14-0-partner_email_check
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/134/14.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module validates and normalizes the field ``email`` in the model
  25. ``res.partner``.
  26. As part of the normalization, email addresses are converted to lowercase.
  27. Optionally, multiple partners can not be allowed to have the same address.
  28. This will not work with multiple comma-separated email addresses in the field,
  29. although validation and normalization are still supported in such cases.
  30. **Table of contents**
  31. .. contents::
  32. :local:
  33. Configuration
  34. =============
  35. Install python package email-validator: ``sudo pip install email-validator``.
  36. To not allow multiple partners to have the same email address, use the
  37. "Filter duplicate email addresses"/``partner_email_check_filter_duplicates``
  38. setting.
  39. To validate that email addresses are deliverable (that the hostname exists),
  40. use the "Check deliverability of email addresses"/``partner_email_check_check_deliverability``
  41. setting.
  42. Usage
  43. =====
  44. This module integrate automatically in all of the view ``res.partner``
  45. Bug Tracker
  46. ===========
  47. Bugs are tracked on `GitHub Issues <https://github.com/OCA/partner-contact/issues>`_.
  48. In case of trouble, please check there if your issue has already been reported.
  49. If you spotted it first, help us smashing it by providing a detailed and welcomed
  50. `feedback <https://github.com/OCA/partner-contact/issues/new?body=module:%20partner_email_check%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  51. Do not contact contributors directly about support or help with technical issues.
  52. Credits
  53. =======
  54. Authors
  55. ~~~~~~~
  56. * Komit
  57. Contributors
  58. ~~~~~~~~~~~~
  59. * Vo Hoang Dat <dat.vh@komit-consulting.com>
  60. * Jean-Charles Drubay <jc@komit-consulting.com>
  61. Maintainers
  62. ~~~~~~~~~~~
  63. This module is maintained by the OCA.
  64. .. image:: https://odoo-community.org/logo.png
  65. :alt: Odoo Community Association
  66. :target: https://odoo-community.org
  67. OCA, or the Odoo Community Association, is a nonprofit organization whose
  68. mission is to support the collaborative development of Odoo features and
  69. promote its widespread use.
  70. This module is part of the `OCA/partner-contact <https://github.com/OCA/partner-contact/tree/14.0/partner_email_check>`_ project on GitHub.
  71. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.