178 lines
6.8 KiB
ReStructuredText
178 lines
6.8 KiB
ReStructuredText
======================================
|
|
AutoVacuum Mail Message and Attachment
|
|
======================================
|
|
|
|
..
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! This file is generated by oca-gen-addon-readme !!
|
|
!! changes will be overwritten. !!
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! source digest: sha256:491db966d4262d620005377d57d6255ffa65095cbcc96229a46efad5d6dec593
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
|
|
.. |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-LGPL--3-blue.png
|
|
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
|
|
:alt: License: LGPL-3
|
|
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
|
|
:target: https://github.com/OCA/server-tools/tree/17.0/autovacuum_message_attachment
|
|
:alt: OCA/server-tools
|
|
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
|
:target: https://translation.odoo-community.org/projects/server-tools-17-0/server-tools-17-0-autovacuum_message_attachment
|
|
: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/server-tools&target_branch=17.0
|
|
:alt: Try me on Runboat
|
|
|
|
|badge1| |badge2| |badge3| |badge4| |badge5|
|
|
|
|
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.
|
|
|
|
**Table of contents**
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
Configuration
|
|
=============
|
|
|
|
To Create AutoVacuum Rules
|
|
--------------------------
|
|
|
|
Go to Settings -> Technical -> Email -> Message And Attachment Vacuum
|
|
Rules
|
|
|
|
- Press the "New" button to add a new rule
|
|
|
|
To Configure the Attachment AutoVacuum Rule
|
|
-------------------------------------------
|
|
|
|
- **Name:** Set the name of the rule
|
|
- **Type:** Select type "Attachment"
|
|
- **Company:** Select a Company
|
|
- **Retention Time:** Set Retention Time in days
|
|
- **Filename Pattern:** Set file name pattern (for example ".pdf")
|
|
- **Inherited Model:** Set the Inherited Model (optional)
|
|
- **Model:** Select the Model to apply the rule to
|
|
- **Model Filter Domain:** Specify the domain for the model to select
|
|
particular records only
|
|
- **Description:** Add a description for the rule set (optional)
|
|
|
|
|image1|
|
|
|
|
To Configure the Message AutoVacuum Rule
|
|
----------------------------------------
|
|
|
|
- **Name:** Set the name of the rule
|
|
- **Type:** Select type "Message"
|
|
- **Company:** Select a Company
|
|
- **Retention Time:** Set Retention Time in days
|
|
- **Message Type:** Select the Message Type to apply the rule to:
|
|
|
|
- **All:** Apply to all messages
|
|
- **Comment:** Apply to comments
|
|
- **System Notification:** Apply to system notifications
|
|
- **User Specific Notification:** Apply to user specific notifications
|
|
|
|
- **Empty Subtype:** Apply to messages with no subtype
|
|
- **Message Subtype:** Press the "Add line" button and select the
|
|
Chatter Message Subtype to apply the rule to
|
|
- **Model:** Select the Model to apply the rule to
|
|
- **Message Filter Domain:** Specify the domain for the model to select
|
|
particular records only
|
|
- **Description:** Add a description for the rule set (optional)
|
|
|
|
|image2|
|
|
|
|
To Configure AutoVacuum Cron Jobs
|
|
---------------------------------
|
|
|
|
Note: The AutoVacuum Mails and Messages and AutoVacuum Attachments
|
|
scheduled actions are created by default and need to be activated.
|
|
|
|
Go to Settings -> Technical -> Automation -> Scheduled Actions
|
|
|
|
- Activate the scheduled actions needed (AutoVacuum Mails and Messages
|
|
and/or AutoVacuum Attachments)
|
|
- Go to Actions -> Unarchive or toggle the Active status of the
|
|
scheduled action
|
|
- Select a record and specify the frequency of the cron job if needed
|
|
|
|
|image3|
|
|
|
|
|image4|
|
|
|
|
Note: It is recommanded to run it frequently and when the system is not
|
|
very loaded. (For instance : once a day, during the night.)
|
|
|
|
.. |image1| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/autovacuum_message_attachment/static/description/Attachment_Vacuum_Rule.png
|
|
.. |image2| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/autovacuum_message_attachment/static/description/Message_Vacuum_Rule.png
|
|
.. |image3| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/autovacuum_message_attachment/static/description/AutoVacuum_Cron_Jobs.png
|
|
.. |image4| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/autovacuum_message_attachment/static/description/AutoVacuum_Cron_Jobs2.png
|
|
|
|
Known issues / Roadmap
|
|
======================
|
|
|
|
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.
|
|
|
|
Bug Tracker
|
|
===========
|
|
|
|
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/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/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**>`_.
|
|
|
|
Do not contact contributors directly about support or help with technical issues.
|
|
|
|
Credits
|
|
=======
|
|
|
|
Authors
|
|
-------
|
|
|
|
* Akretion
|
|
|
|
Contributors
|
|
------------
|
|
|
|
- Florian da Costa <florian.dacosta@akretion.com>
|
|
- Enric Tobella <etobella@creublanca.es>
|
|
- Helly kapatel <helly.kapatel@initos.com>
|
|
- Akim Juillerat <akim.juillerat@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.
|
|
|
|
.. |maintainer-florian-dacosta| image:: https://github.com/florian-dacosta.png?size=40px
|
|
:target: https://github.com/florian-dacosta
|
|
:alt: florian-dacosta
|
|
|
|
Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
|
|
|
|
|maintainer-florian-dacosta|
|
|
|
|
This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/17.0/autovacuum_message_attachment>`_ project on GitHub.
|
|
|
|
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|