social/mail_browser_view
OCA-git-bot 695dee953a [UPD] README.rst 2023-09-03 16:56:56 +00:00
..
controllers [11.0] Add module mail_browser_view 2018-12-04 08:32:19 +00:00
data [11.0] Add module mail_browser_view 2018-12-04 08:32:19 +00:00
demo [11.0] Add module mail_browser_view 2018-12-04 08:32:19 +00:00
i18n [UPD] Update mail_browser_view.pot 2018-12-04 08:43:55 +00:00
models [11.0] Add module mail_browser_view 2018-12-04 08:32:19 +00:00
readme [11.0] Add module mail_browser_view 2018-12-04 08:32:19 +00:00
static/description [UPD] README.rst 2023-09-03 16:56:56 +00:00
tests [11.0] Add module mail_browser_view 2018-12-04 08:32:19 +00:00
README.rst [UPD] README.rst 2023-09-03 16:56:56 +00:00
__init__.py [11.0] Add module mail_browser_view 2018-12-04 08:32:19 +00:00
__manifest__.py [11.0] Add module mail_browser_view 2018-12-04 08:32:19 +00:00

README.rst

=================
Mail Browser View
=================

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

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

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

This module enables you to add a link in your mail templates,
so the users can view the resulting email in the browser in case
they are badly displayed in their clients.

**Table of contents**

.. contents::
   :local:

Configuration
=============

You can configure an expiration time (in hours) by going to
*Settings > Technical > System Parameters*
and changing the value for `mail_browser_view.token_expiration_hours`.

Any zero or negative values will disable the token expiration.
Default value is 720 hours (1 month).

Usage
=====

Upon module installation, a secure token will be generated for each mail,
allowing it to be reached *via* a constructed URL.
You can then put the following placeholder::

    <a href="#" class="view_in_browser_url">View this mail in browser</a>

anywhere in your mail templates (of course, the link text can be changed).
If you use templates not managed through Odoo editor, it is strongly advised
to use the `mail_inline_style` module so the styles do not get messed up.

Be aware that this feature will not work for templates
having "Auto-Delete" value set to `True`.
To avoid any unwanted 404 errors, all the placeholders within such templates
will be removed automatically in the generated mails.

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

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

* Camptocamp

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

* Simone Orsi <simone.orsi@camptocamp.com>
* Patrick Tombez <patrick.tombez@camptocamp.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/social <https://github.com/OCA/social/tree/11.0/mail_browser_view>`_ project on GitHub.

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