=====================================
LDAP mapping for user name and e-mail
=====================================

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

.. |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%2Fserver--auth-lightgray.png?logo=github
    :target: https://github.com/OCA/server-auth/tree/16.0/users_ldap_mail
    :alt: OCA/server-auth
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/server-auth-16-0/server-auth-16-0-users_ldap_mail
    :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/server-auth&target_branch=16.0
    :alt: Try me on Runboat

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

This module extends the functionality of the auth_ldap module to support mail
from LDAP and to allow you to get an e-mail address from LDAP accounts to Odoo
users.

**Table of contents**

.. contents::
   :local:

Usage
=====

To use this module, you need to:

#. Open Odoo in your browser
#. Go to **Settings > General Settings**
#. In the **Integrations** section click on **LDAP Server** under
   **LDAP Authentication**. This will allow you to create your LDAP integration
   settings.
#. When creating or editing a record, under the **Process Parameter** section
   there are two new fields: mail and name, the name of these items will
   correspond with a new user that is created, when a user logs in via LDAP in
   Odoo.

Known issues / Roadmap
======================


* Add tests (use LDAP Mocking through something like https://mockldap.readthedocs.io/en/latest/overview.html)

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

Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-auth/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/server-auth/issues/new?body=module:%20users_ldap_mail%0Aversion:%2016.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
~~~~~~~

* Daniel Reis

Contributors
~~~~~~~~~~~~

* Daniel Reis (https://launchpad.com/~dreis-pt),
* `Tecnativa <https://www.tecnativa.com>`_:

  * Alexandre Díaz
  * João Marques

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.

.. |maintainer-joao-p-marques| image:: https://github.com/joao-p-marques.png?size=40px
    :target: https://github.com/joao-p-marques
    :alt: joao-p-marques

Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-joao-p-marques| 

This module is part of the `OCA/server-auth <https://github.com/OCA/server-auth/tree/16.0/users_ldap_mail>`_ project on GitHub.

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