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>select "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>
</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="behavior"></a>
<h3>Behavior</h3>
<p>When a partner 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>If the message has a specific subtype, all of this will work only
if personal settings allow to receive notification for that specific subtype.
Specifically:</p>
<ul class="simple">
<li>no record for type: message passes</li>
<li>record disabled for type: message don't pass</li>
<li>record enabled for type: message pass</li>
</ul>
<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>
<p>NOTE 2: Odoo's mail machinery has an option <cite>force_send</cite>
to send the email immediately without waiting for the mail queue to be processed.
When this option is used the email is sent right away
and the message record is deleted right after.</p>
<p>A typical use case is the reset password mail.
We assume that if you use that option you really want the email to go out "now"
so when <cite>force_send</cite> is used, digest machinery is completely bypassed.</p>
<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="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="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 smashing 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>