Search 1.9 billion lines of Odoo code on GitHub
mail_digest
<a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.svg">
</a>
<a name="mail-digest-notifications"></a>
<h2>Mail digest notifications</h2>
<a name="features"></a>
<h3>Features</h3>
<p>This module allows users/partners to:</p>
<ul class="simple">
<li>enable "digest mode" in their notification settings</li>
<li>with digest mode on select a frequency: "daily" or "weekly"</li>
<li>configure specific rules per message subtype (enabled/disabled)</li>
<li>globally enable/disable digest based on message's type</li>
</ul>
<p>to receive or to not receive any email notification for a given subtype.</p>
<p>The preference tab on user's form will look like:</p>
<img alt="./images/preview.png" src="./images/preview.png" />
<a name="global-settings"></a>
<h3>Global settings</h3>
<p>By default digest functionality is enabled
for every message type ('email', 'comment', 'notification').
You change this with the config param <cite>mail_digest.enabled_message_types</cite>
whereas you can specify message types separated by comma.</p>
<a name="behavior"></a>
<h3>Behavior</h3>
<p>When a user with digest mode on is notified with a message or an email
all the messages are collected inside a <cite>mail.digest</cite> container.</p>
<p>A daily cron and a weekly cron will take care
of creating a single email per each digest,
which will be sent as a standard email.</p>
<p><strong>Rules</strong></p>
<p>Given that the user has <cite>Notification management = Handle by Emails</cite>...</p>
<p>a message with subtype assigned <strong>will be sent</strong> via digest if:</p>
<blockquote>
<ul class="simple">
<li>global: <cite>mail_digest_enabled_message_types</cite> param enables the message type</li>
<li>user: digest mode is ON for the recipient</li>
<li>user: recipient's user has no specific setting for the subtype</li>
<li>user: recipient's user has no specific disabling setting for the subtype</li>
</ul>
</blockquote>
<p>a message with subtype assigned <strong>will NOT be sent</strong> via digest if:</p>
<blockquote>
<ul class="simple">
<li>global: <cite>mail_digest_enabled_message_types</cite> param disables the message type</li>
<li>user: digest mode is OFF for the recipient</li>
<li>user: recipient's user has disabled the subtype in her/his settings</li>
</ul>
</blockquote>
<p>NOTE: under the hood the digest notification logic excludes followers to be notified,
since you really want to notify only mail.digest's partner.</p>
<a name="digest-rendering-preview"></a>
<h3>Digest rendering preview</h3>
<p>You can check how messages are formatted per each mail subtype by going to <cite>/digest/layout-preview</cite> in your browser.</p>
<img alt="./images/digest_layout_preview.png" src="./images/digest_layout_preview.png" />
<a name="known-issues-roadmap"></a>
<h4>Known issues / Roadmap</h4>
<ul class="simple">
<li>take full control of message and email template.</li>
</ul>
<p>Right now the notification message and the digest mail itself is wrapped inside Odoo mail template.
We should be able to customize this easily.</p>
<a name="migrating-to-v11"></a>
<h3>Migrating to v11</h3>
<p>Notification settings, in Odoo core,
<cite>have been moved to user model <https://github.com/odoo/odoo/commit/2950ffaa86ef38263e9a4a59a30d0768f82a61fa#diff-0c15808786b030dc6c62b0b88196afff></cite>,
and the logic changed a bit.</p>
<p>At the moment there's no staight upgrade provided by this module.
If you need to migrate, keep in mind that:</p>
<ul class="simple">
<li><cite>mail.digest</cite> is now tied to user (partner_id -> user_id)</li>
<li><cite>notify_email</cite> has been removed so to enable digest mode you have to turn on the new flag <cite>digest_mode</cite></li>
<li><cite>notify_frequency</cite> has been moved to user model and is now called <cite>digest_frequency</cite></li>
<li><cite>partner.notification.conf</cite> became <cite>user.notification.conf</cite></li>
<li><cite>notify_conf_ids</cite> now links the new model <cite>user.notification.conf</cite> and moved to user model</li>
</ul>
<a name="bug-tracker"></a>
<h4>Bug Tracker</h4>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/social/issues">GitHub Issues</a>. In case of trouble, please
check there if your issue has already been reported. If you spotted it first,
help us smash it by providing a detailed and welcomed feedback.</p>
<a name="credits"></a>
<h4>Credits</h4>
<a name="contributors"></a>
<h3>Contributors</h3>
<ul class="simple">
<li>Simone Orsi <<a class="reference external" href="mailto:simone.orsi@camptocamp.com">simone.orsi@camptocamp.com</a>></li>
</ul>
<a name="funders"></a>
<h3>Funders</h3>
<p>The development of this module has been financially supported by: <a class="reference external" href="https://fluxdock.io">Fluxdock.io</a></p>
<a name="maintainer"></a>
<h3>Maintainer</h3>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>This module is maintained by the OCA.</p>
<p>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.</p>
<p>To contribute to this module, please visit <a class="reference external" href="https://odoo-community.org">https://odoo-community.org</a>.</p>