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'),
59 'email_cc': fields.char('Cc', help='Carbon copy message recipients'),
60 'reply_to': fields.char('Reply-To', help='Preferred response address for the message'),
61 'body_html': fields.text('Rich-text Contents', help="Rich-text/HTML message"),
63 # Auto-detected based on create() - if 'mail_message_id' was passed then this mail is a notification
64 # and during unlink() we will not cascade delete the parent and its attachments
65 'notification': fields.boolean('Is Notification')
68 def _get_default_from(self, cr, uid, context=None):
69 this = self.pool.get('res.users').browse(cr, uid, uid, context=context)
71 return '%s@%s' % (this.alias_name, this.alias_domain)
74 raise osv.except_osv(_('Invalid Action!'), _("Unable to send email, please configure the sender's email address or alias."))
78 'email_from': lambda self, cr, uid, ctx=None: self._get_default_from(cr, uid, ctx),
81 def default_get(self, cr, uid, fields, context=None):
82 # protection for `default_type` values leaking from menu action context (e.g. for invoices)
83 # To remove when automatic context propagation is removed in web client
84 if context and context.get('default_type') and context.get('default_type') not in self._all_columns['type'].column.selection:
85 context = dict(context, default_type = None)
86 return super(mail_mail, self).default_get(cr, uid, fields, context=context)
88 def create(self, cr, uid, values, context=None):
89 if 'notification' not in values and values.get('mail_message_id'):
90 values['notification'] = True
91 return super(mail_mail, self).create(cr, uid, values, context=context)
93 def unlink(self, cr, uid, ids, context=None):
94 # cascade-delete the parent message for all mails that are not created for a notification
95 ids_to_cascade = self.search(cr, uid, [('notification', '=', False), ('id', 'in', ids)])
96 parent_msg_ids = [m.mail_message_id.id for m in self.browse(cr, uid, ids_to_cascade, context=context)]
97 res = super(mail_mail, self).unlink(cr, uid, ids, context=context)
98 self.pool.get('mail.message').unlink(cr, uid, parent_msg_ids, context=context)
101 def mark_outgoing(self, cr, uid, ids, context=None):
102 return self.write(cr, uid, ids, {'state': 'outgoing'}, context=context)
104 def cancel(self, cr, uid, ids, context=None):
105 return self.write(cr, uid, ids, {'state': 'cancel'}, context=context)
107 def process_email_queue(self, cr, uid, ids=None, context=None):
108 """Send immediately queued messages, committing after each
109 message is sent - this is not transactional and should
110 not be called during another transaction!
112 :param list ids: optional list of emails ids to send. If passed
113 no search is performed, and these ids are used
115 :param dict context: if a 'filters' key is present in context,
116 this value will be used as an additional
117 filter to further restrict the outgoing
118 messages to send (by default all 'outgoing'
124 filters = ['&', ('state', '=', 'outgoing'), ('type', '=', 'email')]
125 if 'filters' in context:
126 filters.extend(context['filters'])
127 ids = self.search(cr, uid, filters, context=context)
130 # Force auto-commit - this is meant to be called by
131 # the scheduler, and we can't allow rolling back the status
132 # of previously sent emails!
133 res = self.send(cr, uid, ids, auto_commit=True, context=context)
135 _logger.exception("Failed processing mail queue")
138 def _postprocess_sent_message(self, cr, uid, mail, context=None):
139 """Perform any post-processing necessary after sending ``mail``
140 successfully, including deleting it completely along with its
141 attachment if the ``auto_delete`` flag of the mail was set.
142 Overridden by subclasses for extra post-processing behaviors.
144 :param browse_record mail: the mail that was just sent
148 # done with SUPERUSER_ID to avoid giving large unlink access rights
149 self.unlink(cr, SUPERUSER_ID, [mail.id], context=context)
152 def send_get_mail_subject(self, cr, uid, mail, force=False, partner=None, context=None):
153 """ If subject is void and record_name defined: '<Author> posted on <Resource>'
155 :param boolean force: force the subject replacement
156 :param browse_record mail: mail.mail browse_record
157 :param browse_record partner: specific recipient partner
159 if force or (not mail.subject and mail.model and mail.res_id):
160 return 'Re: %s' % (mail.record_name)
163 def send_get_mail_body(self, cr, uid, mail, partner=None, context=None):
164 """ Return a specific ir_email body. The main purpose of this method
165 is to be inherited by Portal, to add a link for signing in, in
166 each notification email a partner receives.
168 :param browse_record mail: mail.mail browse_record
169 :param browse_record partner: specific recipient partner
171 body = mail.body_html
172 # partner is a user, link to a related document (incentive to install portal)
173 if partner and partner.user_ids and mail.model and mail.res_id \
174 and self.check_access_rights(cr, partner.user_ids[0].id, 'read', raise_exception=False):
175 related_user = partner.user_ids[0]
177 self.pool.get(mail.model).check_access_rule(cr, related_user.id, [mail.res_id], 'read', context=context)
178 base_url = self.pool.get('ir.config_parameter').get_param(cr, uid, 'web.base.url')
179 # the parameters to encode for the query and fragment part of url
180 query = {'db': cr.dbname}
182 'login': related_user.login,
186 url = urljoin(base_url, "?%s#%s" % (urlencode(query), urlencode(fragment)))
187 text = _("""<small>Access this document <a href="%s">directly in OpenERP</a></small>""") % url
188 body = tools.append_content_to_html(body, ("<div><p>%s</p></div>" % text), plaintext=False, container_tag='div')
189 except except_orm, e:
193 def send_get_mail_reply_to(self, cr, uid, mail, partner=None, context=None):
194 """ Return a specific ir_email body. The main purpose of this method
195 is to be inherited by Portal, to add a link for signing in, in
196 each notification email a partner receives.
198 :param browse_record mail: mail.mail browse_record
199 :param browse_record partner: specific recipient partner
203 if not mail.model or not mail.res_id:
205 if not hasattr(self.pool.get(mail.model), 'message_get_reply_to'):
207 return self.pool.get(mail.model).message_get_reply_to(cr, uid, [mail.res_id], context=context)[0]
209 def send_get_email_dict(self, cr, uid, mail, partner=None, context=None):
210 """ Return a dictionary for specific email values, depending on a
211 partner, or generic to the whole recipients given by mail.email_to.
213 :param browse_record mail: mail.mail browse_record
214 :param browse_record partner: specific recipient partner
216 body = self.send_get_mail_body(cr, uid, mail, partner=partner, context=context)
217 subject = self.send_get_mail_subject(cr, uid, mail, partner=partner, context=context)
218 reply_to = self.send_get_mail_reply_to(cr, uid, mail, partner=partner, context=context)
219 body_alternative = tools.html2plaintext(body)
220 email_to = [partner.email] if partner else tools.email_split(mail.email_to)
223 'body_alternative': body_alternative,
225 'email_to': email_to,
226 'reply_to': reply_to,
229 def send(self, cr, uid, ids, auto_commit=False, recipient_ids=None, context=None):
230 """ Sends the selected emails immediately, ignoring their current
231 state (mails that have already been sent should not be passed
232 unless they should actually be re-sent).
233 Emails successfully delivered are marked as 'sent', and those
234 that fail to be deliver are marked as 'exception', and the
235 corresponding error mail is output in the server logs.
237 :param bool auto_commit: whether to force a commit of the mail status
238 after sending each mail (meant only for scheduler processing);
239 should never be True during normal transactions (default: False)
240 :param list recipient_ids: specific list of res.partner recipients.
241 If set, one email is sent to each partner. Its is possible to
242 tune the sent email through ``send_get_mail_body`` and ``send_get_mail_subject``.
243 If not specified, one email is sent to mail_mail.email_to.
246 ir_mail_server = self.pool.get('ir.mail_server')
247 for mail in self.browse(cr, uid, ids, context=context):
251 for attach in mail.attachment_ids:
252 attachments.append((attach.datas_fname, base64.b64decode(attach.datas)))
253 # specific behavior to customize the send email for notified partners
256 for partner in self.pool.get('res.partner').browse(cr, SUPERUSER_ID, recipient_ids, context=context):
257 email_list.append(self.send_get_email_dict(cr, uid, mail, partner=partner, context=context))
259 email_list.append(self.send_get_email_dict(cr, uid, mail, context=context))
261 # build an RFC2822 email.message.Message object and send it without queuing
262 for email in email_list:
263 msg = ir_mail_server.build_email(
264 email_from = mail.email_from,
265 email_to = email.get('email_to'),
266 subject = email.get('subject'),
267 body = email.get('body'),
268 body_alternative = email.get('body_alternative'),
269 email_cc = tools.email_split(mail.email_cc),
270 reply_to = email.get('reply_to'),
271 attachments = attachments,
272 message_id = mail.message_id,
273 references = mail.references,
274 object_id = mail.res_id and ('%s-%s' % (mail.res_id, mail.model)),
276 subtype_alternative = 'plain')
277 res = ir_mail_server.send_email(cr, uid, msg,
278 mail_server_id=mail.mail_server_id.id, context=context)
280 mail.write({'state': 'sent', 'message_id': res})
283 mail.write({'state': 'exception'})
286 # /!\ can't use mail.state here, as mail.refresh() will cause an error
287 # see revid:odo@openerp.com-20120622152536-42b2s28lvdv3odyr in 6.1
289 self._postprocess_sent_message(cr, uid, mail, context=context)
291 _logger.exception('failed sending mail.mail %s', mail.id)
292 mail.write({'state': 'exception'})
294 if auto_commit == True: