1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2010-today OpenERP SA (<http://www.openerp.com>)
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as
9 # published by the Free Software Foundation, either version 3 of the
10 # License, or (at your option) any later version
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Affero General Public License for more details
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>
20 ##############################################################################
24 from urllib import urlencode
25 from urlparse import urljoin
27 from openerp import tools
28 from openerp import SUPERUSER_ID
29 from openerp.osv import fields, osv
30 from openerp.osv.orm import except_orm
31 from openerp.tools.translate import _
33 _logger = logging.getLogger(__name__)
36 class mail_mail(osv.Model):
37 """ Model holding RFC2822 email messages to send. This model also provides
38 facilities to queue and send new email messages. """
40 _description = 'Outgoing Mails'
41 _inherits = {'mail.message': 'mail_message_id'}
45 'mail_message_id': fields.many2one('mail.message', 'Message', required=True, ondelete='cascade'),
46 'mail_server_id': fields.many2one('ir.mail_server', 'Outgoing mail server', readonly=1),
47 'state': fields.selection([
48 ('outgoing', 'Outgoing'),
50 ('received', 'Received'),
51 ('exception', 'Delivery Failed'),
52 ('cancel', 'Cancelled'),
53 ], 'Status', readonly=True),
54 'auto_delete': fields.boolean('Auto Delete',
55 help="Permanently delete this email after sending it, to save space"),
56 'references': fields.text('References', help='Message references, such as identifiers of previous messages', readonly=1),
57 'email_from': fields.char('From', help='Message sender, taken from user preferences.'),
58 'email_to': fields.text('To', help='Message recipients (emails)'),
59 'recipient_ids': fields.many2many('res.partner', string='Message recipients (partners)'),
60 'email_cc': fields.char('Cc', help='Carbon copy message recipients'),
61 'body_html': fields.text('Rich-text Contents', help="Rich-text/HTML message"),
63 # If not set in create values, auto-detected based on create values (res_id, model, email_from)
64 'reply_to': fields.char('Reply-To', help='Preferred response address for the message'),
66 # Auto-detected based on create() - if 'mail_message_id' was passed then this mail is a notification
67 # and during unlink() we will not cascade delete the parent and its attachments
68 'notification': fields.boolean('Is Notification')
71 def _get_default_from(self, cr, uid, context=None):
72 this = self.pool.get('res.users').browse(cr, SUPERUSER_ID, uid, context=context)
74 return '%s <%s@%s>' % (this.name, this.alias_name, this.alias_domain)
76 return '%s <%s>' % (this.name, this.email)
77 raise osv.except_osv(_('Invalid Action!'), _("Unable to send email, please configure the sender's email address or alias."))
81 'email_from': lambda self, cr, uid, ctx=None: self._get_default_from(cr, uid, ctx),
84 def default_get(self, cr, uid, fields, context=None):
85 # protection for `default_type` values leaking from menu action context (e.g. for invoices)
86 # To remove when automatic context propagation is removed in web client
87 if context and context.get('default_type') and context.get('default_type') not in self._all_columns['type'].column.selection:
88 context = dict(context, default_type=None)
89 return super(mail_mail, self).default_get(cr, uid, fields, context=context)
91 def create(self, cr, uid, values, context=None):
92 if 'notification' not in values and values.get('mail_message_id'):
93 values['notification'] = True
94 if not values.get('reply_to') and values.get('res_id') and values.get('model') and hasattr(self.pool.get(values.get('model')), 'message_get_reply_to'):
95 values['reply_to'] = self.pool.get(values.get('model')).message_get_reply_to(cr, uid, [values.get('res_id')], context=context)[0]
96 elif not values.get('reply_to'):
97 values['reply_to'] = values.get('email_from', False)
98 return super(mail_mail, self).create(cr, uid, values, context=context)
100 def unlink(self, cr, uid, ids, context=None):
101 # cascade-delete the parent message for all mails that are not created for a notification
102 ids_to_cascade = self.search(cr, uid, [('notification', '=', False), ('id', 'in', ids)])
103 parent_msg_ids = [m.mail_message_id.id for m in self.browse(cr, uid, ids_to_cascade, context=context)]
104 res = super(mail_mail, self).unlink(cr, uid, ids, context=context)
105 self.pool.get('mail.message').unlink(cr, uid, parent_msg_ids, context=context)
108 def mark_outgoing(self, cr, uid, ids, context=None):
109 return self.write(cr, uid, ids, {'state': 'outgoing'}, context=context)
111 def cancel(self, cr, uid, ids, context=None):
112 return self.write(cr, uid, ids, {'state': 'cancel'}, context=context)
114 def process_email_queue(self, cr, uid, ids=None, context=None):
115 """Send immediately queued messages, committing after each
116 message is sent - this is not transactional and should
117 not be called during another transaction!
119 :param list ids: optional list of emails ids to send. If passed
120 no search is performed, and these ids are used
122 :param dict context: if a 'filters' key is present in context,
123 this value will be used as an additional
124 filter to further restrict the outgoing
125 messages to send (by default all 'outgoing'
131 filters = ['&', ('state', '=', 'outgoing'), ('type', '=', 'email')]
132 if 'filters' in context:
133 filters.extend(context['filters'])
134 ids = self.search(cr, uid, filters, context=context)
137 # Force auto-commit - this is meant to be called by
138 # the scheduler, and we can't allow rolling back the status
139 # of previously sent emails!
140 res = self.send(cr, uid, ids, auto_commit=True, context=context)
142 _logger.exception("Failed processing mail queue")
145 def _postprocess_sent_message(self, cr, uid, mail, context=None):
146 """Perform any post-processing necessary after sending ``mail``
147 successfully, including deleting it completely along with its
148 attachment if the ``auto_delete`` flag of the mail was set.
149 Overridden by subclasses for extra post-processing behaviors.
151 :param browse_record mail: the mail that was just sent
155 # done with SUPERUSER_ID to avoid giving large unlink access rights
156 self.unlink(cr, SUPERUSER_ID, [mail.id], context=context)
159 def send_get_mail_subject(self, cr, uid, mail, force=False, partner=None, context=None):
160 """ If subject is void and record_name defined: '<Author> posted on <Resource>'
162 :param boolean force: force the subject replacement
163 :param browse_record mail: mail.mail browse_record
164 :param browse_record partner: specific recipient partner
166 if force or (not mail.subject and mail.model and mail.res_id):
167 return 'Re: %s' % (mail.record_name)
170 def send_get_mail_body(self, cr, uid, mail, partner=None, context=None):
171 """ Return a specific ir_email body. The main purpose of this method
172 is to be inherited by Portal, to add a link for signing in, in
173 each notification email a partner receives.
175 :param browse_record mail: mail.mail browse_record
176 :param browse_record partner: specific recipient partner
178 body = mail.body_html
179 # partner is a user, link to a related document (incentive to install portal)
180 if partner and partner.user_ids and mail.model and mail.res_id \
181 and self.check_access_rights(cr, partner.user_ids[0].id, 'read', raise_exception=False):
182 related_user = partner.user_ids[0]
184 self.pool.get(mail.model).check_access_rule(cr, related_user.id, [mail.res_id], 'read', context=context)
185 base_url = self.pool.get('ir.config_parameter').get_param(cr, uid, 'web.base.url')
186 # the parameters to encode for the query and fragment part of url
187 query = {'db': cr.dbname}
189 'login': related_user.login,
193 url = urljoin(base_url, "?%s#%s" % (urlencode(query), urlencode(fragment)))
194 text = _("""<p>Access this document <a href="%s">directly in OpenERP</a></p>""") % url
195 body = tools.append_content_to_html(body, ("<div><p>%s</p></div>" % text), plaintext=False)
196 except except_orm, e:
200 def send_get_email_dict(self, cr, uid, mail, partner=None, context=None):
201 """ Return a dictionary for specific email values, depending on a
202 partner, or generic to the whole recipients given by mail.email_to.
204 :param browse_record mail: mail.mail browse_record
205 :param browse_record partner: specific recipient partner
207 body = self.send_get_mail_body(cr, uid, mail, partner=partner, context=context)
208 subject = self.send_get_mail_subject(cr, uid, mail, partner=partner, context=context)
209 body_alternative = tools.html2plaintext(body)
210 email_to = [partner.email] if partner else tools.email_split(mail.email_to)
213 'body_alternative': body_alternative,
215 'email_to': email_to,
218 def send(self, cr, uid, ids, auto_commit=False, context=None):
219 """ Sends the selected emails immediately, ignoring their current
220 state (mails that have already been sent should not be passed
221 unless they should actually be re-sent).
222 Emails successfully delivered are marked as 'sent', and those
223 that fail to be deliver are marked as 'exception', and the
224 corresponding error mail is output in the server logs.
226 :param bool auto_commit: whether to force a commit of the mail status
227 after sending each mail (meant only for scheduler processing);
228 should never be True during normal transactions (default: False)
231 ir_mail_server = self.pool.get('ir.mail_server')
232 for mail in self.browse(cr, SUPERUSER_ID, ids, context=context):
236 for attach in mail.attachment_ids:
237 attachments.append((attach.datas_fname, base64.b64decode(attach.datas)))
238 # specific behavior to customize the send email for notified partners
241 email_list.append(self.send_get_email_dict(cr, uid, mail, context=context))
242 for partner in mail.recipient_ids:
243 email_list.append(self.send_get_email_dict(cr, uid, mail, partner=partner, context=context))
245 # build an RFC2822 email.message.Message object and send it without queuing
246 for email in email_list:
247 msg = ir_mail_server.build_email(
248 email_from = mail.email_from,
249 email_to = email.get('email_to'),
250 subject = email.get('subject'),
251 body = email.get('body'),
252 body_alternative = email.get('body_alternative'),
253 email_cc = tools.email_split(mail.email_cc),
254 reply_to = mail.reply_to,
255 attachments = attachments,
256 message_id = mail.message_id,
257 references = mail.references,
258 object_id = mail.res_id and ('%s-%s' % (mail.res_id, mail.model)),
260 subtype_alternative = 'plain')
261 res = ir_mail_server.send_email(cr, uid, msg,
262 mail_server_id=mail.mail_server_id.id, context=context)
264 mail.write({'state': 'sent', 'message_id': res})
267 mail.write({'state': 'exception'})
270 # /!\ can't use mail.state here, as mail.refresh() will cause an error
271 # see revid:odo@openerp.com-20120622152536-42b2s28lvdv3odyr in 6.1
273 self._postprocess_sent_message(cr, uid, mail, context=context)
275 _logger.exception('failed sending mail.mail %s', mail.id)
276 mail.write({'state': 'exception'})
278 if auto_commit == True: