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.2 KiB

  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  3. :alt: License: AGPL-3
  4. ==========================
  5. Mass mailing sending queue
  6. ==========================
  7. This module adds a queue for generating mail records when mass mailing
  8. 'Send to All' button is clicked. This is an additional queue, apart from
  9. the existing one (implemented in addons/mail) for doing the actual sending.
  10. Configuration
  11. =============
  12. There is a system parameter, 'mail.mass_mailing.sending.batch_size'
  13. (default value is 500), to control how many emails are created in each
  14. cron iteration (method 'mail.mass_mailing.sending.cron()').
  15. Usage
  16. =====
  17. Without this module, when 'Send to All' button is clicked at mass mailing form,
  18. all 'mail.mail' and 'mail.mail.statistics' objects are created. This process
  19. might take a long time if the recipient list is 10k+ and the famous
  20. "Take a minute to get a coffee, because it's loading..." text might appear.
  21. With this new queue, mass mailing will appear in 'Sending' state to the user
  22. until all emails are sent or failed. After 'Send to All' button is clicked,
  23. the user will quickly land to the mass mailing form.
  24. In 'Mass mailing' form, a new tab "Sending tasks" has been added where the
  25. user can check the Sent mails history.
  26. In 'Settings > Technical > Email > Mass mailing sending' allowed users can
  27. track all running mass mailing sending objects and see:
  28. * Pending recipients: Number of recipients for which the email is not yet created.
  29. * Start date: Date when user press 'Send to All' button.
  30. * Mails to be sent: number of emails waiting to be sent.
  31. * Sent mails: number of emails successfully sent.
  32. * Failed mails: number of unsent emails due to error.
  33. NOTE: User will not be able to send the same mass mailing again if another
  34. one is ongoing. An UserError exception is raised in this case.
  35. NOTE: If number of recipients are less than 'batch_size / 2', then all
  36. emails are created when 'Send to All' button is clicked (standard way).
  37. Although a sending object is created anyway in order to be consistent.
  38. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  39. :alt: Try me on Runbot
  40. :target: https://runbot.odoo-community.org/runbot/205/8.0
  41. Bug Tracker
  42. ===========
  43. Bugs are tracked on `GitHub Issues
  44. <https://github.com/OCA/social/issues>`_. In case of trouble, please
  45. check there if your issue has already been reported. If you spotted it first,
  46. help us smashing it by providing a detailed and welcomed feedback.
  47. Credits
  48. =======
  49. Images
  50. ------
  51. * Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
  52. Contributors
  53. ------------
  54. * Antonio Espinosa <antonio.espinosa@tecnativa.com>
  55. * Pedro M. Baeza <pedro.baeza@tecnativa.com>
  56. Maintainer
  57. ----------
  58. .. image:: https://odoo-community.org/logo.png
  59. :alt: Odoo Community Association
  60. :target: https://odoo-community.org
  61. This module is maintained by the OCA.
  62. OCA, or the Odoo Community Association, is a nonprofit organization whose
  63. mission is to support the collaborative development of Odoo features and
  64. promote its widespread use.
  65. To contribute to this module, please visit https://odoo-community.org.