517 lines
18 KiB
HTML
517 lines
18 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
|
|
<title>AutoVacuum Mail Message and Attachment</title>
|
|
<style type="text/css">
|
|
|
|
/*
|
|
:Author: David Goodger (goodger@python.org)
|
|
:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
|
|
:Copyright: This stylesheet has been placed in the public domain.
|
|
|
|
Default cascading style sheet for the HTML output of Docutils.
|
|
Despite the name, some widely supported CSS2 features are used.
|
|
|
|
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
|
|
customize this style sheet.
|
|
*/
|
|
|
|
/* used to remove borders from tables and images */
|
|
.borderless, table.borderless td, table.borderless th {
|
|
border: 0 }
|
|
|
|
table.borderless td, table.borderless th {
|
|
/* Override padding for "table.docutils td" with "! important".
|
|
The right padding separates the table cells. */
|
|
padding: 0 0.5em 0 0 ! important }
|
|
|
|
.first {
|
|
/* Override more specific margin styles with "! important". */
|
|
margin-top: 0 ! important }
|
|
|
|
.last, .with-subtitle {
|
|
margin-bottom: 0 ! important }
|
|
|
|
.hidden {
|
|
display: none }
|
|
|
|
.subscript {
|
|
vertical-align: sub;
|
|
font-size: smaller }
|
|
|
|
.superscript {
|
|
vertical-align: super;
|
|
font-size: smaller }
|
|
|
|
a.toc-backref {
|
|
text-decoration: none ;
|
|
color: black }
|
|
|
|
blockquote.epigraph {
|
|
margin: 2em 5em ; }
|
|
|
|
dl.docutils dd {
|
|
margin-bottom: 0.5em }
|
|
|
|
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
|
|
overflow: hidden;
|
|
}
|
|
|
|
/* Uncomment (and remove this text!) to get bold-faced definition list terms
|
|
dl.docutils dt {
|
|
font-weight: bold }
|
|
*/
|
|
|
|
div.abstract {
|
|
margin: 2em 5em }
|
|
|
|
div.abstract p.topic-title {
|
|
font-weight: bold ;
|
|
text-align: center }
|
|
|
|
div.admonition, div.attention, div.caution, div.danger, div.error,
|
|
div.hint, div.important, div.note, div.tip, div.warning {
|
|
margin: 2em ;
|
|
border: medium outset ;
|
|
padding: 1em }
|
|
|
|
div.admonition p.admonition-title, div.hint p.admonition-title,
|
|
div.important p.admonition-title, div.note p.admonition-title,
|
|
div.tip p.admonition-title {
|
|
font-weight: bold ;
|
|
font-family: sans-serif }
|
|
|
|
div.attention p.admonition-title, div.caution p.admonition-title,
|
|
div.danger p.admonition-title, div.error p.admonition-title,
|
|
div.warning p.admonition-title, .code .error {
|
|
color: red ;
|
|
font-weight: bold ;
|
|
font-family: sans-serif }
|
|
|
|
/* Uncomment (and remove this text!) to get reduced vertical space in
|
|
compound paragraphs.
|
|
div.compound .compound-first, div.compound .compound-middle {
|
|
margin-bottom: 0.5em }
|
|
|
|
div.compound .compound-last, div.compound .compound-middle {
|
|
margin-top: 0.5em }
|
|
*/
|
|
|
|
div.dedication {
|
|
margin: 2em 5em ;
|
|
text-align: center ;
|
|
font-style: italic }
|
|
|
|
div.dedication p.topic-title {
|
|
font-weight: bold ;
|
|
font-style: normal }
|
|
|
|
div.figure {
|
|
margin-left: 2em ;
|
|
margin-right: 2em }
|
|
|
|
div.footer, div.header {
|
|
clear: both;
|
|
font-size: smaller }
|
|
|
|
div.line-block {
|
|
display: block ;
|
|
margin-top: 1em ;
|
|
margin-bottom: 1em }
|
|
|
|
div.line-block div.line-block {
|
|
margin-top: 0 ;
|
|
margin-bottom: 0 ;
|
|
margin-left: 1.5em }
|
|
|
|
div.sidebar {
|
|
margin: 0 0 0.5em 1em ;
|
|
border: medium outset ;
|
|
padding: 1em ;
|
|
background-color: #ffffee ;
|
|
width: 40% ;
|
|
float: right ;
|
|
clear: right }
|
|
|
|
div.sidebar p.rubric {
|
|
font-family: sans-serif ;
|
|
font-size: medium }
|
|
|
|
div.system-messages {
|
|
margin: 5em }
|
|
|
|
div.system-messages h1 {
|
|
color: red }
|
|
|
|
div.system-message {
|
|
border: medium outset ;
|
|
padding: 1em }
|
|
|
|
div.system-message p.system-message-title {
|
|
color: red ;
|
|
font-weight: bold }
|
|
|
|
div.topic {
|
|
margin: 2em }
|
|
|
|
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
|
|
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
|
|
margin-top: 0.4em }
|
|
|
|
h1.title {
|
|
text-align: center }
|
|
|
|
h2.subtitle {
|
|
text-align: center }
|
|
|
|
hr.docutils {
|
|
width: 75% }
|
|
|
|
img.align-left, .figure.align-left, object.align-left, table.align-left {
|
|
clear: left ;
|
|
float: left ;
|
|
margin-right: 1em }
|
|
|
|
img.align-right, .figure.align-right, object.align-right, table.align-right {
|
|
clear: right ;
|
|
float: right ;
|
|
margin-left: 1em }
|
|
|
|
img.align-center, .figure.align-center, object.align-center {
|
|
display: block;
|
|
margin-left: auto;
|
|
margin-right: auto;
|
|
}
|
|
|
|
table.align-center {
|
|
margin-left: auto;
|
|
margin-right: auto;
|
|
}
|
|
|
|
.align-left {
|
|
text-align: left }
|
|
|
|
.align-center {
|
|
clear: both ;
|
|
text-align: center }
|
|
|
|
.align-right {
|
|
text-align: right }
|
|
|
|
/* reset inner alignment in figures */
|
|
div.align-right {
|
|
text-align: inherit }
|
|
|
|
/* div.align-center * { */
|
|
/* text-align: left } */
|
|
|
|
.align-top {
|
|
vertical-align: top }
|
|
|
|
.align-middle {
|
|
vertical-align: middle }
|
|
|
|
.align-bottom {
|
|
vertical-align: bottom }
|
|
|
|
ol.simple, ul.simple {
|
|
margin-bottom: 1em }
|
|
|
|
ol.arabic {
|
|
list-style: decimal }
|
|
|
|
ol.loweralpha {
|
|
list-style: lower-alpha }
|
|
|
|
ol.upperalpha {
|
|
list-style: upper-alpha }
|
|
|
|
ol.lowerroman {
|
|
list-style: lower-roman }
|
|
|
|
ol.upperroman {
|
|
list-style: upper-roman }
|
|
|
|
p.attribution {
|
|
text-align: right ;
|
|
margin-left: 50% }
|
|
|
|
p.caption {
|
|
font-style: italic }
|
|
|
|
p.credits {
|
|
font-style: italic ;
|
|
font-size: smaller }
|
|
|
|
p.label {
|
|
white-space: nowrap }
|
|
|
|
p.rubric {
|
|
font-weight: bold ;
|
|
font-size: larger ;
|
|
color: maroon ;
|
|
text-align: center }
|
|
|
|
p.sidebar-title {
|
|
font-family: sans-serif ;
|
|
font-weight: bold ;
|
|
font-size: larger }
|
|
|
|
p.sidebar-subtitle {
|
|
font-family: sans-serif ;
|
|
font-weight: bold }
|
|
|
|
p.topic-title {
|
|
font-weight: bold }
|
|
|
|
pre.address {
|
|
margin-bottom: 0 ;
|
|
margin-top: 0 ;
|
|
font: inherit }
|
|
|
|
pre.literal-block, pre.doctest-block, pre.math, pre.code {
|
|
margin-left: 2em ;
|
|
margin-right: 2em }
|
|
|
|
pre.code .ln { color: gray; } /* line numbers */
|
|
pre.code, code { background-color: #eeeeee }
|
|
pre.code .comment, code .comment { color: #5C6576 }
|
|
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
|
|
pre.code .literal.string, code .literal.string { color: #0C5404 }
|
|
pre.code .name.builtin, code .name.builtin { color: #352B84 }
|
|
pre.code .deleted, code .deleted { background-color: #DEB0A1}
|
|
pre.code .inserted, code .inserted { background-color: #A3D289}
|
|
|
|
span.classifier {
|
|
font-family: sans-serif ;
|
|
font-style: oblique }
|
|
|
|
span.classifier-delimiter {
|
|
font-family: sans-serif ;
|
|
font-weight: bold }
|
|
|
|
span.interpreted {
|
|
font-family: sans-serif }
|
|
|
|
span.option {
|
|
white-space: nowrap }
|
|
|
|
span.pre {
|
|
white-space: pre }
|
|
|
|
span.problematic, pre.problematic {
|
|
color: red }
|
|
|
|
span.section-subtitle {
|
|
/* font-size relative to parent (h1..h6 element) */
|
|
font-size: 80% }
|
|
|
|
table.citation {
|
|
border-left: solid 1px gray;
|
|
margin-left: 1px }
|
|
|
|
table.docinfo {
|
|
margin: 2em 4em }
|
|
|
|
table.docutils {
|
|
margin-top: 0.5em ;
|
|
margin-bottom: 0.5em }
|
|
|
|
table.footnote {
|
|
border-left: solid 1px black;
|
|
margin-left: 1px }
|
|
|
|
table.docutils td, table.docutils th,
|
|
table.docinfo td, table.docinfo th {
|
|
padding-left: 0.5em ;
|
|
padding-right: 0.5em ;
|
|
vertical-align: top }
|
|
|
|
table.docutils th.field-name, table.docinfo th.docinfo-name {
|
|
font-weight: bold ;
|
|
text-align: left ;
|
|
white-space: nowrap ;
|
|
padding-left: 0 }
|
|
|
|
/* "booktabs" style (no vertical lines) */
|
|
table.docutils.booktabs {
|
|
border: 0px;
|
|
border-top: 2px solid;
|
|
border-bottom: 2px solid;
|
|
border-collapse: collapse;
|
|
}
|
|
table.docutils.booktabs * {
|
|
border: 0px;
|
|
}
|
|
table.docutils.booktabs th {
|
|
border-bottom: thin solid;
|
|
text-align: left;
|
|
}
|
|
|
|
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
|
|
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
|
|
font-size: 100% }
|
|
|
|
ul.auto-toc {
|
|
list-style-type: none }
|
|
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<div class="document" id="autovacuum-mail-message-and-attachment">
|
|
<h1 class="title">AutoVacuum Mail Message and Attachment</h1>
|
|
|
|
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! This file is generated by oca-gen-addon-readme !!
|
|
!! changes will be overwritten. !!
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! source digest: sha256:491db966d4262d620005377d57d6255ffa65095cbcc96229a46efad5d6dec593
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
|
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-tools/tree/17.0/autovacuum_message_attachment"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-tools-17-0/server-tools-17-0-autovacuum_message_attachment"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=17.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
|
|
<p>Odoo create a lot of message and/or mails. With time it can slow the
|
|
system or take a lot of disk space. The goal of this module is to clean
|
|
these message once they are obsolete. The same may happen with
|
|
attachment that we store. You can choose various criterias manage which
|
|
messages you want to delete automatically.</p>
|
|
<p><strong>Table of contents</strong></p>
|
|
<div class="contents local topic" id="contents">
|
|
<ul class="simple">
|
|
<li><a class="reference internal" href="#configuration" id="toc-entry-1">Configuration</a><ul>
|
|
<li><a class="reference internal" href="#to-create-autovacuum-rules" id="toc-entry-2">To Create AutoVacuum Rules</a></li>
|
|
<li><a class="reference internal" href="#to-configure-the-attachment-autovacuum-rule" id="toc-entry-3">To Configure the Attachment AutoVacuum Rule</a></li>
|
|
<li><a class="reference internal" href="#to-configure-the-message-autovacuum-rule" id="toc-entry-4">To Configure the Message AutoVacuum Rule</a></li>
|
|
<li><a class="reference internal" href="#to-configure-autovacuum-cron-jobs" id="toc-entry-5">To Configure AutoVacuum Cron Jobs</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="reference internal" href="#known-issues-roadmap" id="toc-entry-6">Known issues / Roadmap</a></li>
|
|
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-7">Bug Tracker</a></li>
|
|
<li><a class="reference internal" href="#credits" id="toc-entry-8">Credits</a><ul>
|
|
<li><a class="reference internal" href="#authors" id="toc-entry-9">Authors</a></li>
|
|
<li><a class="reference internal" href="#contributors" id="toc-entry-10">Contributors</a></li>
|
|
<li><a class="reference internal" href="#maintainers" id="toc-entry-11">Maintainers</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="configuration">
|
|
<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
|
|
<div class="section" id="to-create-autovacuum-rules">
|
|
<h2><a class="toc-backref" href="#toc-entry-2">To Create AutoVacuum Rules</a></h2>
|
|
<p>Go to Settings -> Technical -> Email -> Message And Attachment Vacuum
|
|
Rules</p>
|
|
<ul class="simple">
|
|
<li>Press the “New” button to add a new rule</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="to-configure-the-attachment-autovacuum-rule">
|
|
<h2><a class="toc-backref" href="#toc-entry-3">To Configure the Attachment AutoVacuum Rule</a></h2>
|
|
<ul class="simple">
|
|
<li><strong>Name:</strong> Set the name of the rule</li>
|
|
<li><strong>Type:</strong> Select type “Attachment”</li>
|
|
<li><strong>Company:</strong> Select a Company</li>
|
|
<li><strong>Retention Time:</strong> Set Retention Time in days</li>
|
|
<li><strong>Filename Pattern:</strong> Set file name pattern (for example “.pdf”)</li>
|
|
<li><strong>Inherited Model:</strong> Set the Inherited Model (optional)</li>
|
|
<li><strong>Model:</strong> Select the Model to apply the rule to</li>
|
|
<li><strong>Model Filter Domain:</strong> Specify the domain for the model to select
|
|
particular records only</li>
|
|
<li><strong>Description:</strong> Add a description for the rule set (optional)</li>
|
|
</ul>
|
|
<p><img alt="image1" src="https://raw.githubusercontent.com/OCA/server-tools/17.0/autovacuum_message_attachment/static/description/Attachment_Vacuum_Rule.png" /></p>
|
|
</div>
|
|
<div class="section" id="to-configure-the-message-autovacuum-rule">
|
|
<h2><a class="toc-backref" href="#toc-entry-4">To Configure the Message AutoVacuum Rule</a></h2>
|
|
<ul class="simple">
|
|
<li><strong>Name:</strong> Set the name of the rule</li>
|
|
<li><strong>Type:</strong> Select type “Message”</li>
|
|
<li><strong>Company:</strong> Select a Company</li>
|
|
<li><strong>Retention Time:</strong> Set Retention Time in days</li>
|
|
<li><strong>Message Type:</strong> Select the Message Type to apply the rule to:<ul>
|
|
<li><strong>All:</strong> Apply to all messages</li>
|
|
<li><strong>Comment:</strong> Apply to comments</li>
|
|
<li><strong>System Notification:</strong> Apply to system notifications</li>
|
|
<li><strong>User Specific Notification:</strong> Apply to user specific notifications</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong>Empty Subtype:</strong> Apply to messages with no subtype</li>
|
|
<li><strong>Message Subtype:</strong> Press the “Add line” button and select the
|
|
Chatter Message Subtype to apply the rule to</li>
|
|
<li><strong>Model:</strong> Select the Model to apply the rule to</li>
|
|
<li><strong>Message Filter Domain:</strong> Specify the domain for the model to select
|
|
particular records only</li>
|
|
<li><strong>Description:</strong> Add a description for the rule set (optional)</li>
|
|
</ul>
|
|
<p><img alt="image2" src="https://raw.githubusercontent.com/OCA/server-tools/17.0/autovacuum_message_attachment/static/description/Message_Vacuum_Rule.png" /></p>
|
|
</div>
|
|
<div class="section" id="to-configure-autovacuum-cron-jobs">
|
|
<h2><a class="toc-backref" href="#toc-entry-5">To Configure AutoVacuum Cron Jobs</a></h2>
|
|
<p>Note: The AutoVacuum Mails and Messages and AutoVacuum Attachments
|
|
scheduled actions are created by default and need to be activated.</p>
|
|
<p>Go to Settings -> Technical -> Automation -> Scheduled Actions</p>
|
|
<ul class="simple">
|
|
<li>Activate the scheduled actions needed (AutoVacuum Mails and Messages
|
|
and/or AutoVacuum Attachments)</li>
|
|
<li>Go to Actions -> Unarchive or toggle the Active status of the
|
|
scheduled action</li>
|
|
<li>Select a record and specify the frequency of the cron job if needed</li>
|
|
</ul>
|
|
<p><img alt="image3" src="https://raw.githubusercontent.com/OCA/server-tools/17.0/autovacuum_message_attachment/static/description/AutoVacuum_Cron_Jobs.png" /></p>
|
|
<p><img alt="image4" src="https://raw.githubusercontent.com/OCA/server-tools/17.0/autovacuum_message_attachment/static/description/AutoVacuum_Cron_Jobs2.png" /></p>
|
|
<p>Note: It is recommanded to run it frequently and when the system is not
|
|
very loaded. (For instance : once a day, during the night.)</p>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="known-issues-roadmap">
|
|
<h1><a class="toc-backref" href="#toc-entry-6">Known issues / Roadmap</a></h1>
|
|
<p>You have to be careful with rules regarding attachment deletion because
|
|
Odoo find the attachment to delete with their name. Odoo will find all
|
|
attachments containing the substring configured on the rule, so you have
|
|
to be specific enough on the other criterias (concerned models…) to
|
|
avoid unwanted attachment deletion.</p>
|
|
</div>
|
|
<div class="section" id="bug-tracker">
|
|
<h1><a class="toc-backref" href="#toc-entry-7">Bug Tracker</a></h1>
|
|
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/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 to smash it by providing a detailed and welcomed
|
|
<a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20autovacuum_message_attachment%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
|
|
<p>Do not contact contributors directly about support or help with technical issues.</p>
|
|
</div>
|
|
<div class="section" id="credits">
|
|
<h1><a class="toc-backref" href="#toc-entry-8">Credits</a></h1>
|
|
<div class="section" id="authors">
|
|
<h2><a class="toc-backref" href="#toc-entry-9">Authors</a></h2>
|
|
<ul class="simple">
|
|
<li>Akretion</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="contributors">
|
|
<h2><a class="toc-backref" href="#toc-entry-10">Contributors</a></h2>
|
|
<ul class="simple">
|
|
<li>Florian da Costa <<a class="reference external" href="mailto:florian.dacosta@akretion.com">florian.dacosta@akretion.com</a>></li>
|
|
<li>Enric Tobella <<a class="reference external" href="mailto:etobella@creublanca.es">etobella@creublanca.es</a>></li>
|
|
<li>Helly kapatel <<a class="reference external" href="mailto:helly.kapatel@initos.com">helly.kapatel@initos.com</a>></li>
|
|
<li>Akim Juillerat <<a class="reference external" href="mailto:akim.juillerat@camptocamp.com">akim.juillerat@camptocamp.com</a>></li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="maintainers">
|
|
<h2><a class="toc-backref" href="#toc-entry-11">Maintainers</a></h2>
|
|
<p>This module is maintained by the OCA.</p>
|
|
<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>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>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
|
|
<p><a class="reference external image-reference" href="https://github.com/florian-dacosta"><img alt="florian-dacosta" src="https://github.com/florian-dacosta.png?size=40px" /></a></p>
|
|
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/17.0/autovacuum_message_attachment">OCA/server-tools</a> project on GitHub.</p>
|
|
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|