[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>
2021-10-07 11:06:25 +00:00
parent 3a2bbc028b
commit debe8cb393
39 changed files with 276 additions and 177 deletions
@@ -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>`_
@@ -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
@@ -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