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.

98 lines
3.3 KiB

  1. ============
  2. Mail cleanup
  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-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-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/mail_cleanup
  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-mail_cleanup
  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. This module allows to:
  25. ----------------------
  26. * mark e-mails older than x days as read,
  27. * move those messages in a specific folder,
  28. * remove messages older than x days
  29. on IMAP servers, just before fetching them.
  30. Since the main "mail" module does not mark unroutable e-mails as read,
  31. this means that if junk mail arrives in the catch-all address without
  32. any default route, fetching newer e-mails will happen after re-parsing
  33. those unroutable e-mails.
  34. **Table of contents**
  35. .. contents::
  36. :local:
  37. Configuration
  38. =============
  39. This module depends on ``mail_environment`` in order to add "expiration dates"
  40. per server.
  41. Example of a configuration file (add those values to your server)::
  42. [incoming_mail.openerp_imap_mail1]
  43. cleanup_days = False # default value
  44. purge_days = False # default value
  45. cleanup_folder = NotParsed # optional parameter
  46. Bug Tracker
  47. ===========
  48. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  49. In case of trouble, please check there if your issue has already been reported.
  50. If you spotted it first, help us smashing it by providing a detailed and welcomed
  51. `feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20mail_cleanup%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  52. Do not contact contributors directly about support or help with technical issues.
  53. Credits
  54. =======
  55. Authors
  56. ~~~~~~~
  57. * Camptocamp
  58. Contributors
  59. ~~~~~~~~~~~~
  60. * Matthieu Dietrich <matthieu.dietrich@camptocamp.com>
  61. * Artem Kostyuk <a.kostyuk@mobilunity.com>
  62. Maintainers
  63. ~~~~~~~~~~~
  64. This module is maintained by the OCA.
  65. .. image:: https://odoo-community.org/logo.png
  66. :alt: Odoo Community Association
  67. :target: https://odoo-community.org
  68. OCA, or the Odoo Community Association, is a nonprofit organization whose
  69. mission is to support the collaborative development of Odoo features and
  70. promote its widespread use.
  71. This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/12.0/mail_cleanup>`_ project on GitHub.
  72. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.