You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

93 lines
3.9 KiB

  1. ======================================
  2. AutoVacuum Mail Message and Attachment
  3. ======================================
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
  13. :alt: License: LGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
  15. :target: https://github.com/OCA/server-tools/tree/12.0/autovacuum_message_attachment
  16. :alt: OCA/server-tools
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/server-tools-12-0/server-tools-12-0-autovacuum_message_attachment
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/149/12.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. Odoo create a lot of message and/or mails. With time it can slow the system or take a lot of disk space.
  25. The goal of this module is to clean these message once they are obsolete.
  26. The same may happen with attachment that we store.
  27. You can choose various criterias manage which messages you want to delete automatically.
  28. **Table of contents**
  29. .. contents::
  30. :local:
  31. Configuration
  32. =============
  33. * Go to the menu configuration => Technical => Email => Message And Attachment Vacuum Rules
  34. * Add the adequates rules for your company. On each rule, you can indicate the models, type and subtypes for which you want to delete the messages, along with a retention time (in days). Or for attachment, you can specify a substring of the name.
  35. * Activate the cron AutoVacuum Mails and Messages and/or AutoVacuum Attachments
  36. It is recommanded to run it frequently and when the system is not very loaded.
  37. (For instance : once a day, during the night.)
  38. Known issues / Roadmap
  39. ======================
  40. You have to be careful with rules regarding attachment deletion because Odoo find the attachment to delete with their name.
  41. 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.
  42. Bug Tracker
  43. ===========
  44. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  45. In case of trouble, please check there if your issue has already been reported.
  46. If you spotted it first, help us smashing it by providing a detailed and welcomed
  47. `feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20autovacuum_message_attachment%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  48. Do not contact contributors directly about support or help with technical issues.
  49. Credits
  50. =======
  51. Authors
  52. ~~~~~~~
  53. * Akretion
  54. Contributors
  55. ~~~~~~~~~~~~
  56. * Florian da Costa <florian.dacosta@akretion.com>
  57. * Enric Tobella <etobella@creublanca.es>
  58. Maintainers
  59. ~~~~~~~~~~~
  60. This module is maintained by the OCA.
  61. .. image:: https://odoo-community.org/logo.png
  62. :alt: Odoo Community Association
  63. :target: https://odoo-community.org
  64. OCA, or the Odoo Community Association, is a nonprofit organization whose
  65. mission is to support the collaborative development of Odoo features and
  66. promote its widespread use.
  67. This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/12.0/autovacuum_message_attachment>`_ project on GitHub.
  68. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.