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

10 years ago
10 years ago
  1. Email gateway - folders
  2. =======================
  3. Adds the possibility to attach emails from a certain IMAP folder to objects,
  4. ie partners. Matching is done via several algorithms, ie email address, email
  5. address's domain or the original Odoo algorithm.
  6. This gives a simple possibility to archive emails in Odoo without a mail
  7. client integration.
  8. Configuration
  9. =============
  10. In your fetchmail configuration, you'll find a new list field `Folders to
  11. monitor`. Add your folders here in IMAP notation (usually something like
  12. `INBOX.your_folder_name.your_subfolder_name`), choose a model to attach mails
  13. to and a matching algorithm to use.
  14. Exact mailaddress
  15. -----------------
  16. Fill in a field to search for the email address in `Field (model)`. For
  17. partners, this would be `email`. Also fill in the header field from the email
  18. to look at in `Field (email)`. If you want to match incoming mails from your
  19. customers, this would be `from`. You can also list header fields, so to match
  20. partners receiving this email, you might fill in `to,cc,bcc`.
  21. Domain of email addresses
  22. -------------------------
  23. Match the domain of the email address(es) found in `Field (email)`. This would
  24. attach a mail to `test1@example.com` to a record with `Field (model)` set to
  25. `test2@example.com`. Given that this is a fuzzy match, you probably want to
  26. check `Use 1st match`, because otherwise nothing happens if multiple possible
  27. matches are found.
  28. Odoo standard
  29. -------------
  30. This is stricly speaking no matching algorithm, but calls the model's standard
  31. action on new incoming mail, which is usually creating a new record.
  32. Usage
  33. =====
  34. A widespread configuration is to have a shared mailbox with several folders,
  35. i.e. one where users drop mails they want to attach to partners. Let this
  36. folder be called `From partners`. Then create a folder configuration for your
  37. server with path `"INBOX.From partners"` (note the quotes because of the space,
  38. this is server dependent). Choose model `Partners`, set `Field (model)` to
  39. `email` and `Field (email)` to `from`. In `Domain`, you could fill in
  40. `[('customer', '=', True)]` to be sure to only match customer records.
  41. Now when your users drop mails into this folder, they will be fetched by Odoo
  42. and attached to the partner in question. After some testing, you might want to
  43. check `Delete matches` in your folder configuration so that this folder doesn't
  44. grow indefinitely.
  45. Bug Tracker
  46. ===========
  47. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  48. In case of trouble, please check there if your issue has already been reported.
  49. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
  50. `here <https://github.com/OCA/server-tools/issues/new?body=module:%20fetchmail_attach_from_folder%0Aversion:%208.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  51. Credits
  52. =======
  53. Contributors
  54. ------------
  55. * Holger Brunn <hbrunn@therp.nl>
  56. Icon
  57. ----
  58. http://commons.wikimedia.org/wiki/File:Crystal_Clear_filesystem_folder_favorites.png
  59. Maintainer
  60. ----------
  61. .. image:: http://odoo-community.org/logo.png
  62. :alt: Odoo Community Association
  63. :target: http://odoo-community.org
  64. This module is maintained by the OCA.
  65. 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.
  66. To contribute to this module, please visit http://odoo-community.org.