[DOC] Small doc update.
bzr revid: tde@openerp.com-20120416081805-wz85d6sxd90n472b
This commit is contained in:
parent
c83f54289d
commit
0912faef4c
|
@ -1,6 +1,12 @@
|
||||||
:orphan:
|
|
||||||
|
|
||||||
Mail module documentation
|
Mail module documentation
|
||||||
=========================
|
=========================
|
||||||
|
|
||||||
|
The Mail module holds all models and logic related to messages management. At low-level, it handles messages and offers an API to message queues for email sending. At an higher level, it provides the OpenChatter feature that is a thread management system inside OpenERP. A model that inherits from the mail module adds OpenChatter to its document. Its gives them the following capabilities :
|
||||||
|
|
||||||
|
- messages management with a threaded design
|
||||||
|
- subscription mechanism tha allow users to follow/unfollow documents
|
||||||
|
- notifications mechanism; notifications are pushed to users to form a Wall page holding the latest pushed messages
|
||||||
|
|
||||||
|
The mail module also comes with an email composition wizard, along with discussion groups.
|
||||||
|
|
||||||
.. include:: index.rst.inc
|
.. include:: index.rst.inc
|
||||||
|
|
|
@ -4,5 +4,6 @@ Mail Module
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
|
mail_message
|
||||||
mail_thread
|
mail_thread
|
||||||
|
|
|
@ -10,6 +10,7 @@ mail.group
|
||||||
|
|
||||||
A mail_group is a collection of users sharing messages in a discussion group. Group users are users that follow the mail group, using the subscription/follow mechanism of OpenSocial. A mail group has nothing in common wih res.users.group.
|
A mail_group is a collection of users sharing messages in a discussion group. Group users are users that follow the mail group, using the subscription/follow mechanism of OpenSocial. A mail group has nothing in common wih res.users.group.
|
||||||
Additional information on fields:
|
Additional information on fields:
|
||||||
|
|
||||||
- ``member_ids``: user member of the groups are calculated with ``message_get_subscribers`` method from mail.thread
|
- ``member_ids``: user member of the groups are calculated with ``message_get_subscribers`` method from mail.thread
|
||||||
- ``member_count``: calculated with member_ids
|
- ``member_count``: calculated with member_ids
|
||||||
- ``is_subscriber``: calculated with member_ids
|
- ``is_subscriber``: calculated with member_ids
|
||||||
|
|
|
@ -388,6 +388,11 @@ openerp.mail = function(session) {
|
||||||
return this.fetch_comments(this.params.limit, this.params.offset, domain);
|
return this.fetch_comments(this.params.limit, this.params.offset, domain);
|
||||||
},
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* var regex_login = new RegExp(/(^|\s)@((\w|@|\.)*)/g);
|
||||||
|
* var regex_intlink = new RegExp(/(^|\s)#(\w*[a-zA-Z_]+\w*)\.(\w+[a-zA-Z_]+\w*),(\w+)/g);
|
||||||
|
*/
|
||||||
do_replace_internal_links: function (string) {
|
do_replace_internal_links: function (string) {
|
||||||
var self = this;
|
var self = this;
|
||||||
var icon_list = ['al', 'pinky']
|
var icon_list = ['al', 'pinky']
|
||||||
|
@ -427,7 +432,6 @@ openerp.mail = function(session) {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* var regex_login = new RegExp(/(^|\s)@(\w*[a-zA-Z_.]+\w*\s)/g);
|
|
||||||
* var regex_login = new RegExp(/(^|\s)@((\w|@|\.)*)/g);
|
* var regex_login = new RegExp(/(^|\s)@((\w|@|\.)*)/g);
|
||||||
* var regex_intlink = new RegExp(/(^|\s)#(\w*[a-zA-Z_]+\w*)\.(\w+[a-zA-Z_]+\w*),(\w+)/g);
|
* var regex_intlink = new RegExp(/(^|\s)#(\w*[a-zA-Z_]+\w*)\.(\w+[a-zA-Z_]+\w*),(\w+)/g);
|
||||||
*/
|
*/
|
||||||
|
|
Loading…
Reference in New Issue