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.

121 lines
4.1 KiB

  1. ===============================
  2. Welcome mail to new subscribers
  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%2Fsocial-lightgray.png?logo=github
  15. :target: https://github.com/OCA/social/tree/11.0/mass_mailing_newsletter_welcome_mail
  16. :alt: OCA/social
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/social-11-0/social-11-0-mass_mailing_newsletter_welcome_mail
  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/205/11.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module was written to extend the functionality of the website popup
  25. newsletter subscription form to support sending to new subscribers an
  26. automatic welcome email and allow you to customize it.
  27. **Table of contents**
  28. .. contents::
  29. :local:
  30. Configuration
  31. =============
  32. To configure this module, you need to:
  33. #. Go to *Email Marketing > Contacts > Mailing Lists*.
  34. #. Edit or create one.
  35. #. Set a *Welcome mail template* to enable this module's special behavior when
  36. somebody subscribes to this mailing list. You can use one shipped with
  37. this module, called *Welcome mail to newsletter subscribers*,
  38. as a starting point.
  39. #. You can also customize this template as you prefer.
  40. To be used, you also must make sure a subscription snippet for this list exists
  41. somewhere in your website:
  42. #. Go to your website.
  43. #. Navigate to a page where you want to include the subscription widget.
  44. #. *Edit* the webpage.
  45. #. Drag and drop any *Structure* or *Features* block you like.
  46. #. Drag and drop the *Inner content > Newsletter* block inside it.
  47. #. Choose the same mailing list you configured above.
  48. Of course, outgoing mail must be properly configured in your instance, or
  49. emails will never be sent.
  50. Usage
  51. =====
  52. After you have followed the configuration instructions:
  53. #. Enter as an anonymous user (you can use a browser private window for that).
  54. #. Navigate to the page where the newsletter subscription snippet is found.
  55. #. Enter your email.
  56. #. Hit *Subscribe*.
  57. #. Check your inbox, you have new mail!
  58. Known issues / Roadmap
  59. ======================
  60. * Add tests.
  61. Bug Tracker
  62. ===========
  63. Bugs are tracked on `GitHub Issues <https://github.com/OCA/social/issues>`_.
  64. In case of trouble, please check there if your issue has already been reported.
  65. If you spotted it first, help us smashing it by providing a detailed and welcomed
  66. `feedback <https://github.com/OCA/social/issues/new?body=module:%20mass_mailing_newsletter_welcome_mail%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  67. Do not contact contributors directly about support or help with technical issues.
  68. Credits
  69. =======
  70. Authors
  71. ~~~~~~~
  72. * Tecnativa
  73. Contributors
  74. ~~~~~~~~~~~~
  75. * `Tecnativa <https://www.tecnativa.com>`__:
  76. * Cristina Martin R.
  77. * Jairo Llopis
  78. Maintainers
  79. ~~~~~~~~~~~
  80. This module is maintained by the OCA.
  81. .. image:: https://odoo-community.org/logo.png
  82. :alt: Odoo Community Association
  83. :target: https://odoo-community.org
  84. OCA, or the Odoo Community Association, is a nonprofit organization whose
  85. mission is to support the collaborative development of Odoo features and
  86. promote its widespread use.
  87. This module is part of the `OCA/social <https://github.com/OCA/social/tree/11.0/mass_mailing_newsletter_welcome_mail>`_ project on GitHub.
  88. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.