[IMP] mail plugins: add gmail plugin + update and move outlook plugin

Task ID: 2662764

closes odoo/documentation#1167

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit is contained in:
Xavier 2021-10-07 11:06:25 +00:00
parent 3a2bbc028b
commit debe8cb393
39 changed files with 276 additions and 177 deletions

View File

@ -100,5 +100,5 @@ The synchronization is a two-way process, meaning that events are reconciled in
to manage a specific instance of Microsoft cloud services for your internal and external users.
.. seealso::
- :doc:`../../../sales/crm/optimize/outlook_extension`
- :doc:`../../../productivity/mail_plugins/outlook`
- :doc:`../google/google_calendar_credentials`

View File

@ -9,4 +9,5 @@ Productivity
productivity/discuss
productivity/iot
productivity/mail_plugins
productivity/studio

View File

@ -0,0 +1,54 @@
:show-content:
============
Mail Plugins
============
.. toctree::
:titlesonly:
mail_plugins/outlook
mail_plugins/gmail
Mail Plugins are connectors that bridge your mailbox with your Odoo database. With them, you can
interact with your Odoo database directly from your mailbox by:
- Creating leads and centralizing prospects' emails into the CRM app.
- Generating tasks in any Odoo project.
- Creating tickets in the Helpdesk app.
- Searching and storing insights on your contacts.
.. _mail_plugins/pricing:
Pricing
=======
Mail Plugins are **free** to install and use.
However, they can provide **Lead Enrichment**, which is part of a paid service known as **Lead
Generation**.
Mail plugins allow you to test Lead Enrichment for free, whether you connect the plugins to a
database or not. After a while, the plugins ask you to buy :doc:`../general/in_app_purchase`
credits if you would like to keep using this service.
.. _mail_plugins/lead-generation:
Lead Generation IAP service
---------------------------
Lead Enrichment uses the *Lead Generation IAP service*. Each request consumes one *Lead Generation
credit*.
To buy credits, go to :menuselection:`Settings --> CRM --> Lead Enrichment --> Buy credits` and
select a package.
.. note::
- If you are out of credits, the only information populated when clicking on the suggested
company is its website link and logo.
- Check out the `Lead Generation IAP service Privacy Policy
<https://iap.odoo.com/privacy#header_3>`_.
.. seealso::
- :doc:`../general/in_app_purchase`
- `Odoo Tutorials: Lead Enrichment <https://www.odoo.com/r/p73>`_

View File

@ -0,0 +1,95 @@
============
Gmail Plugin
============
Configuration
=============
The Odoo-Gmail :doc:`Mail Plugin <../mail_plugins>` needs to be configured both on Odoo and Gmail.
.. _mail-plugin/gmail/enable-mail-plugin:
Enable Mail Plugin
------------------
First, you need to enable the *Mail Plugin* feature in your database. Go to :menuselection:`Settings
--> General Settings --> Integrations`, enable *Mail Plugin*, and *Save* the configuration.
.. _mail-plugin/gmail/install-plugin:
Install the Odoo-Gmail Plugin
-----------------------------
#. Open the `Gmail Plugin Apps Script project
<https://script.google.com/d/1n7cxtaR4fGXKcP0RwinNQmL8S4FhVqpo-ZZ_cUAhYuuDpZAP_CnHE_7q/edit>`_.
#. Verify you are logged in using the Google account you want to install the plugin on.
#. Click on *Publish* then *Deploy from manifest...*
.. image:: gmail/deploy-from-manifest.png
:align: center
:alt: Deploying from manifest the Gmail Plugin from the Apps Script project
.. important::
Make sure you are using the legacy editor, otherwise the *Deploy from manifest* functionality
may not be available.
.. image:: gmail/legacy-editor.png
:align: center
:alt: Using the legacy editor in the Gmail Plugin Apps Script project
#. Click on *Install add-on*. A "Deployment installed" notification should appear. You can then
click on *Close*.
.. image:: gmail/install-add-on.png
:align: center
:alt: Installing the Gmail Plugin from the Apps Script project
.. _mail-plugin/gmail/configure-mailbox:
Configure your Gmail mailbox
----------------------------
#. Open any email in your Gmail mailbox. On the right-side panel, click on the Odoo icon and then
*Authorize Access*.
.. image:: gmail/authorize-access.png
:align: center
:alt: Authorizing access to the Gmail Plugin
#. Choose the right Google account.
.. image:: gmail/choose-account.png
:align: center
:alt: Choosing your Google account
#. Allow the Gmail Plugin to access some of your data.
.. image:: gmail/allow-permissions.png
:align: center
:alt: Allowing the Gmail Plugin to access Google data
#. The right-side panel can now display **Company Insights**. At the bottom, click on *Login*.
.. image:: gmail/panel-login.png
:align: center
:alt: Logging in your Odoo database
.. note::
Only a limited amount of *Company Insights* (*Lead Enrichment*) requests are available as a
trial. This feature requires :ref:`prepaid credits <mail_plugins/pricing>`.
#. Enter your Odoo database URL and click on *Login*.
.. image:: gmail/database-url.png
:align: center
:alt: Entering your Odoo database URL
#. If you aren't logged into your database, enter your credentials.
#. Click on *Allow* to let the Odoo-Gmail Plugin connect to your database.
.. image:: gmail/odoo-permission.png
:align: center
:alt: Allowing the Gmail Plugin to connect to a database

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.5 KiB

View File

@ -0,0 +1,123 @@
==============
Outlook Plugin
==============
Configuration
=============
The Odoo-Outlook :doc:`Mail Plugin <../mail_plugins>` needs to be configured both on Odoo and
Outlook.
.. _mail-plugin/outlook/enable-mail-plugin:
Enable Mail Plugin
------------------
First, you need to enable the *Mail Plugin* feature in your database. Go to :menuselection:`Settings
--> General Settings --> Integrations`, enable *Mail Plugin*, and *Save* the configuration.
.. _mail-plugin/outlook/install-plugin:
Install the Outlook Plugin
--------------------------
#. Open your Outlook mailbox and select any email.
#. Click on the *More actions* button and select *Get Add-ins*.
.. image:: outlook/more-actions.png
:align: center
:alt: More actions button in Outlook
#. Select the *My add-ins* tab.
.. image:: outlook/my-add-ins.png
:align: center
:alt: My add-ins in Outlook
#. Under *Custom add-ins*, click on *+ Add a custom add-in*, and then on *Add from URL...*
.. image:: outlook/custom-add-ins.png
:align: center
:alt: Custom add-ins in Outlook
#. Enter the following URL `https://download.odoo.com/plugins/outlook/manifest.xml` and press
*OK*.
.. image:: outlook/enter-add-in-url.png
:align: center
:alt: Entering the add-in URL in Outlook
#. Read the warning and click on *Install*.
.. image:: outlook/add-in-warning.png
:align: center
:alt: Custom add-in installation warning in Outlook
.. _mail-plugin/outlook/connect-database:
Connect your database
---------------------
#. Open any email in your Outlook mailbox, click on the *More actions* button, and select *Odoo for
Outlook*.
.. image:: outlook/odoo-for-outlook.png
:align: center
:alt: Odoo for Outlook add-in button
#. The right-side panel can now display **Company Insights**. At the bottom, click on *Login*.
.. image:: outlook/panel-login.png
:align: center
:alt: Logging in your Odoo database
.. note::
Only a limited amount of *Company Insights* (*Lead Enrichment*) requests are available as a
trial. This feature requires :ref:`prepaid credits <mail_plugins/pricing>`.
#. Enter your Odoo database URL and click on *Login*.
.. image:: outlook/enter-database-url.png
:align: center
:alt: Entering your Odoo database URL
#. Click on *Allow* to open the pop-up window.
.. image:: outlook/new-window-warning.png
:align: center
:alt: New window pop-up warning
#. If you aren't logged into your database, enter your credentials.
#. Click on *Allow* to let the Outlook Plugin connect to your database.
.. image:: outlook/odoo-permission.png
:align: center
:alt: Allowing the Outlook Plugin to connect to a database
.. _mail-plugin/outlook/add-shortcut:
Add a shortcut to the plugin
----------------------------
By default, the Outlook Plugin can be opened from the *More actions* menu. However, to save
time, it's possible to add it next to the other default actions.
#. In your Outlook mailbox, click on *Settings*, then on *View all Outlook settings*.
.. image:: outlook/all-outlook-settings.png
:align: center
:alt: Viewing all Outlook settings
#. Select *Customize actions* under *Mail*, click on *Odoo for Outlook*, and then *Save*.
.. image:: outlook/customize-actions.png
:align: center
:alt: Odoo for Outlook customized action
#. Open any email and the shortcut should be displayed.
.. image:: outlook/odoo-outlook-shortcut.png
:align: center
:alt: Odoo for Outlook customized action

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.4 KiB

View File

@ -8,5 +8,4 @@ Optimize your Day-to-Day work
:titlesonly:
optimize/partner_autocomplete
optimize/outlook_extension
optimize/gamification

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 29 KiB

View File

@ -1,175 +0,0 @@
=================
Outlook Extension
=================
The **Odoo CRM Extension** is a connector that bridges your Outlook mailbox with your Odoo database.
This extension allows you to:
- Create leads from emails sent to your mailbox.
- Centralize Prospects' emails into a CRM.
- Search and store insights on your contacts.
.. image:: media/outlook-extension-overview.png
:align: center
:alt: Overview of the Outlook Extension in Outlook
.. note::
This extension is compatible with the Web version of Outlook as well as the desktop apps.
.. important::
The Outlook Extension uses *Partner Autocomplete IAP credits* to search and store insights on
your contacts. See the :ref:`Pricing section <outlook_extension/pricing>` below for more
information.
.. _outlook_extension/configuration:
Configuration
=============
The Outlook Extension requires to be configured both in Odoo and in Outlook.
.. _outlook_extension/enable-feature:
Enable the feature on your database
-----------------------------------
To enable this feature on your Odoo database, go to :menuselection:`CRM --> Configuration --> Lead
Generation`, enable **Outlook CRM Extension**, and click on *Save*.
.. _outlook_extension/add-in-installation:
Install the add-in on Outlook
-----------------------------
You can install the Outlook Extension as a **Custom Add-in**. To do so, follow these steps:
.. important::
| URL of the **Odoo for Outlook** add-in's manifest file:
| ``https://download.odoo.com/plugins/outlook/manifest.xml``
.. todo:: add copy button when the feature is added to the doc
#. Connect to your Outlook mailbox, open any email, and click on the *More actions* button,
displayed as three little dots.
.. image:: media/outlook-extension-more-actions.png
:align: center
:alt: The button "More actions" in Outlook
#. Click on *Get add-ins*.
.. image:: media/outlook-extension-get-add-ins.png
:align: center
:alt: List of actions in Outlook, including the installation of new add-ins
#. In the new window, select the tab named *My add-ins*, click on *+ Add a custom add-in*, and then
on *Add from URL...*
.. image:: media/outlook-extension-custom-add-ins.png
:align: center
:alt: Installation of a custom add-in in Outlook
#. | Outlook prompts you to **enter the URL of the add-in's manifest file**. To do so, copy the
following URL, paste it in the box, and click on *OK*.
| ``https://download.odoo.com/plugins/outlook/manifest.xml``
.. image:: media/outlook-extension-add-in-url.png
:align: center
:alt: Getting a custom add-in in Outlook by providing the manifest file's URL
#. Outlook warns you that Microsoft hasnt verified the add-in. Click on *Install* to complete the
installation.
.. note::
The *Odoo for Outlook* add-in is not listed yet on Outlook's add-ins list. This is why it is
currently necessary to install it as a *custom add-in*.
.. _outlook_extension/connection:
Add a shortcut to open the extension
------------------------------------
By default, you can open the **Odoo for Outlook** extension from the *More actions* menu. This
section explains how to move the launcher next to the other default actions.
.. image:: media/outlook-extension-default-actions.png
:align: center
:alt: Odoo for Outlook extension as a default action in the mailbox
#. In your Outlook mailbox, click on *Settings*, then on *View all Outlook settings*.
#. Go to :menuselection:`Settings --> Mail --> Customize actions --> Message surface`, select
*Odoo for Outlook*, and click on *Save*.
.. image:: media/outlook-extension-customize-actions.png
:align: center
:alt: add Odoo for Outlook extension as a default action in the message surface
Connect to your database
------------------------
#. Open **Odoo for Outlook** from any email. This opens the extension as a panel on the right side of
your screen.
#. Click on *login* at the bottom of the extension.
#. Insert your database's URL then click on *Login*.
.. image:: media/outlook-extension-database-url.png
:align: center
:alt: Connection to an Odoo database from the Outlook extension
#. Log into your database by entering your credentials. Skip this step if you are already logged in
with this browser.
#. A message asks you if you want to let Outlook access your Odoo database. Click on *Allow* to
complete the connection.
.. important::
Make sure first to :ref:`enable the feature on your database
<outlook_extension/enable-feature>`. Failing to do so would result in an *error 404 message*.
.. note::
The extension displays some information, even if you do not connect it to any Odoo database.
Note that only a limited amount of contact enrichment requests are available as a trial, as this
feature requires prepaid credits. See the :ref:`Pricing section <outlook_extension/pricing>`
below for more information.
.. _outlook_extension/pricing:
Pricing
=======
The extension is **free** and doesn't require any purchase to be installed and used.
However, this extension provides you with *Lead Enrichment* in the **Company Insights** section.
This service is part of a paid service known as **Lead Generation**.
The extension allows you to test this service for free, whether you connect the extension to a
database or not. After a while, the extension asks you to buy credits to keep using this additional
service.
.. image:: media/outlook-extension-credits-message.png
:align: center
:alt: "Could not auto-complete the company: not enough credits!" warning message in the Outlook
extension
.. tip::
You can buy more *Lead Generation* credits to keep using this service or disregard this message
and keep using the extension for free without *Lead Enrichment*.
In-App Purchase
---------------
| *Lead Generation* is an *In-App Purchase (IAP)* service, which requires prepaid credits to be
used. Each request consumes one credit.
| To buy credits, go to :menuselection:`Settings --> Contacts --> Partner Autocomplete or Odoo IAP -->
View My Services` and select a package.
.. note::
- If you run out of credits, the only information populated when clicking on the suggested
company is the website link and logo.
- If you are on Odoo Online (SAAS) and have the Enterprise version, you benefit from free
trial credits to test the feature.
- Learn about our *Privacy Policy* `here <https://iap.odoo.com/privacy#header_2>`_.
.. seealso::
- :doc:`../../../general/in_app_purchase`
- `Odoo Tutorials: Lead Enrichment <https://www.odoo.com/r/p73>`_

View File

@ -280,3 +280,5 @@ purchase/replenishment/flows/setup_stock_rule.rst applications/inventory_and_mrp
purchase/replenishment/multicompany/setup.rst applications/general/multi_companies/manage_multi_companies.rst # (#814)
# Redirections introduced in 15.0 :
sales/crm/optimize/outlook_extension.rst productivity/mail_plugins/outlook.rst