diff --git a/mail_post_defer/README.rst b/mail_post_defer/README.rst index 38929e877..e9488133a 100644 --- a/mail_post_defer/README.rst +++ b/mail_post_defer/README.rst @@ -1,35 +1,139 @@ -**This file is going to be generated by oca-gen-addon-readme.** +======================== +Deferred Message Posting +======================== -*Manual changes will be overwritten.* +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -Please provide content in the ``readme`` directory: +.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png + :target: https://odoo-community.org/page/development-status + :alt: Alpha +.. |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%2Fsocial-lightgray.png?logo=github + :target: https://github.com/OCA/social/tree/15.0/mail_post_defer + :alt: OCA/social +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/social-15-0/social-15-0-mail_post_defer + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/205/15.0 + :alt: Try me on Runbot -* **DESCRIPTION.rst** (required) -* INSTALL.rst (optional) -* CONFIGURE.rst (optional) -* **USAGE.rst** (optional, highly recommended) -* DEVELOP.rst (optional) -* ROADMAP.rst (optional) -* HISTORY.rst (optional, recommended) -* **CONTRIBUTORS.rst** (optional, highly recommended) -* CREDITS.rst (optional) +|badge1| |badge2| |badge3| |badge4| |badge5| -Content of this README will also be drawn from the addon manifest, -from keys such as name, authors, maintainers, development_status, -and license. +This module enhances mail threads by using the mail queue by default. -A good, one sentence summary in the manifest is also highly recommended. +Without this module, Odoo attempts to notify recipients of your message immediately. +If your mail server is slow or you have many followers, this can mean a lot of time. +Install this module and make Odoo more snappy! +All emails will be kept in the outgoing queue by at least 30 seconds, +giving you some time to re-think what you wrote. During that time, +you can still delete the message and start again. -Automatic changelog generation -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. IMPORTANT:: + This is an alpha version, the data model and design can change at any time without warning. + Only for development or testing purpose, do not use in production. + `More details on development status `_ -`HISTORY.rst` can be auto generated using `towncrier `_. +**Table of contents** -Just put towncrier compatible changelog fragments into `readme/newsfragments` -and the changelog file will be automatically generated and updated when a new fragment is added. +.. contents:: + :local: -Please refer to `towncrier` documentation to know more. +Configuration +============= -NOTE: the changelog will be automatically generated when using `/ocabot merge $option`. -If you need to run it manually, refer to `OCA/maintainer-tools README `_. +You need to do nothing. The module is configured appropriately out of the box. + +The mail queue processing is made by a cron job. This is normal Odoo behavior, +not specific to this module. However, since you will start using that queue for +every message posted by any user in any thread, this module configures that job +to execute every minute by default. + +You can still change that cadence after installing the module (although it is +not recommended). To do so: + +#. Log in with an administrator user. +#. Activate developer mode. +#. Go to *Settings > Technical > Automation > Scheduled Actions*. +#. Edit the action named "Mail: Email Queue Manager". +#. Lower down the frequency in the field *Execute Every*. Recommended: 1 minute. + +Usage +===== + +To use this module, you need to: + +#. Go to the form view of any record that has a mail thread. It can be a partner, for example. +#. Post a message. + +The mail is now in the outgoing mail queue. It will be there for at least 30 +seconds. It will be really sent the next time the "Mail: Email Queue Manager" +cron job is executed. + +While the message has not been yet sent: + +#. Hover over the little envelope. You will see a paper airplane icon, + indicating it is still outgoing. +#. Hover over the message and click on the little trash icon to delete it. + Mails will not be sent. + +Known issues / Roadmap +====================== + +* Add minimal deferring time configuration if it ever becomes necessary. See + https://github.com/OCA/social/pull/1001#issuecomment-1461581573 for the + rationale behind current hardcoded value of 30 seconds. + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Moduon + +Contributors +~~~~~~~~~~~~ + +* Jairo Llopis (https://www.moduon.team/) + +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-Yajo| image:: https://github.com/Yajo.png?size=40px + :target: https://github.com/Yajo + :alt: Yajo + +Current `maintainer `__: + +|maintainer-Yajo| + +This module is part of the `OCA/social `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/mail_post_defer/static/description/index.html b/mail_post_defer/static/description/index.html new file mode 100644 index 000000000..184437546 --- /dev/null +++ b/mail_post_defer/static/description/index.html @@ -0,0 +1,479 @@ + + + + + + +Deferred Message Posting + + + +
+

Deferred Message Posting

+ + +

Alpha License: LGPL-3 OCA/social Translate me on Weblate Try me on Runbot

+

This module enhances mail threads by using the mail queue by default.

+

Without this module, Odoo attempts to notify recipients of your message immediately. +If your mail server is slow or you have many followers, this can mean a lot of time. +Install this module and make Odoo more snappy!

+

All emails will be kept in the outgoing queue by at least 30 seconds, +giving you some time to re-think what you wrote. During that time, +you can still delete the message and start again.

+
+

Important

+

This is an alpha version, the data model and design can change at any time without warning. +Only for development or testing purpose, do not use in production. +More details on development status

+
+

Table of contents

+ +
+

Configuration

+

You need to do nothing. The module is configured appropriately out of the box.

+

The mail queue processing is made by a cron job. This is normal Odoo behavior, +not specific to this module. However, since you will start using that queue for +every message posted by any user in any thread, this module configures that job +to execute every minute by default.

+

You can still change that cadence after installing the module (although it is +not recommended). To do so:

+
    +
  1. Log in with an administrator user.
    2. +
  2. Activate developer mode.
    3. +
  3. Go to Settings > Technical > Automation > Scheduled Actions.
    4. +
  4. Edit the action named “Mail: Email Queue Manager”.
    5. +
  5. Lower down the frequency in the field Execute Every. Recommended: 1 minute.
    6. +
+
+
+

Usage

+

To use this module, you need to:

+
    +
  1. Go to the form view of any record that has a mail thread. It can be a partner, for example.
    2. +
  2. Post a message.
    3. +
+

The mail is now in the outgoing mail queue. It will be there for at least 30 +seconds. It will be really sent the next time the “Mail: Email Queue Manager” +cron job is executed.

+

While the message has not been yet sent:

+
    +
  1. Hover over the little envelope. You will see a paper airplane icon, +indicating it is still outgoing.
    2. +
  2. Hover over the message and click on the little trash icon to delete it. +Mails will not be sent.
    3. +
+
+
+

Known issues / Roadmap

+ +
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Moduon
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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.

+

Current maintainer:

+

Yajo

+

This module is part of the OCA/social project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ +