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 openerp import tools
26 from openerp import SUPERUSER_ID
27 from openerp.osv import fields, osv
28 from openerp.tools.translate import _
30 _logger = logging.getLogger(__name__)
33 class mail_mail(osv.Model):
34 """ Model holding RFC2822 email messages to send. This model also provides
35 facilities to queue and send new email messages. """
37 _description = 'Outgoing Mails'
38 _inherits = {'mail.message': 'mail_message_id'}
42 'mail_message_id': fields.many2one('mail.message', 'Message', required=True, ondelete='cascade'),
43 'mail_server_id': fields.many2one('ir.mail_server', 'Outgoing mail server', readonly=1),
44 'state': fields.selection([
45 ('outgoing', 'Outgoing'),
47 ('received', 'Received'),
48 ('exception', 'Delivery Failed'),
49 ('cancel', 'Cancelled'),
50 ], 'Status', readonly=True),
51 'auto_delete': fields.boolean('Auto Delete',
52 help="Permanently delete this email after sending it, to save space"),
53 'references': fields.text('References', help='Message references, such as identifiers of previous messages', readonly=1),
54 'email_from': fields.char('From', help='Message sender, taken from user preferences.'),
55 'email_to': fields.text('To', help='Message recipients'),
56 'email_cc': fields.char('Cc', help='Carbon copy message recipients'),
57 'reply_to': fields.char('Reply-To', help='Preferred response address for the message'),
58 'body_html': fields.text('Rich-text Contents', help="Rich-text/HTML message"),
60 # Auto-detected based on create() - if 'mail_message_id' was passed then this mail is a notification
61 # and during unlink() we will not cascade delete the parent and its attachments
62 'notification': fields.boolean('Is Notification')
65 def _get_default_from(self, cr, uid, context=None):
66 this = self.pool.get('res.users').browse(cr, uid, uid, context=context)
68 return '%s@%s' % (this.alias_name, this.alias_domain)
71 raise osv.except_osv(_('Invalid Action!'), _("Unable to send email, please configure the sender's email address or alias."))
75 'email_from': lambda self, cr, uid, ctx=None: self._get_default_from(cr, uid, ctx),
78 def create(self, cr, uid, values, context=None):
79 if 'notification' not in values and values.get('mail_message_id'):
80 values['notification'] = True
81 return super(mail_mail, self).create(cr, uid, values, context=context)
83 def unlink(self, cr, uid, ids, context=None):
84 # cascade-delete the parent message for all mails that are not created for a notification
85 ids_to_cascade = self.search(cr, uid, [('notification', '=', False), ('id', 'in', ids)])
86 parent_msg_ids = [m.mail_message_id.id for m in self.browse(cr, uid, ids_to_cascade, context=context)]
87 res = super(mail_mail, self).unlink(cr, uid, ids, context=context)
88 self.pool.get('mail.message').unlink(cr, uid, parent_msg_ids, context=context)
91 def mark_outgoing(self, cr, uid, ids, context=None):
92 return self.write(cr, uid, ids, {'state': 'outgoing'}, context=context)
94 def cancel(self, cr, uid, ids, context=None):
95 return self.write(cr, uid, ids, {'state': 'cancel'}, context=context)
97 def process_email_queue(self, cr, uid, ids=None, context=None):
98 """Send immediately queued messages, committing after each
99 message is sent - this is not transactional and should
100 not be called during another transaction!
102 :param list ids: optional list of emails ids to send. If passed
103 no search is performed, and these ids are used
105 :param dict context: if a 'filters' key is present in context,
106 this value will be used as an additional
107 filter to further restrict the outgoing
108 messages to send (by default all 'outgoing'
114 filters = ['&', ('state', '=', 'outgoing'), ('type', '=', 'email')]
115 if 'filters' in context:
116 filters.extend(context['filters'])
117 ids = self.search(cr, uid, filters, context=context)
120 # Force auto-commit - this is meant to be called by
121 # the scheduler, and we can't allow rolling back the status
122 # of previously sent emails!
123 res = self.send(cr, uid, ids, auto_commit=True, context=context)
125 _logger.exception("Failed processing mail queue")
128 def _postprocess_sent_message(self, cr, uid, mail, context=None):
129 """Perform any post-processing necessary after sending ``mail``
130 successfully, including deleting it completely along with its
131 attachment if the ``auto_delete`` flag of the mail was set.
132 Overridden by subclasses for extra post-processing behaviors.
134 :param browse_record mail: the mail that was just sent
138 # done with SUPERUSER_ID to avoid giving large unlink access rights
139 self.unlink(cr, SUPERUSER_ID, [mail.id], context=context)
142 def send_get_mail_subject(self, cr, uid, mail, force=False, partner=None, context=None):
143 """ If subject is void and record_name defined: '<Author> posted on <Resource>'
145 :param boolean force: force the subject replacement
146 :param browse_record mail: mail.mail browse_record
147 :param browse_record partner: specific recipient partner
149 if force or (not mail.subject and mail.model and mail.res_id):
150 return '%s posted on %s' % (mail.author_id.name, mail.record_name)
153 def send_get_mail_body(self, cr, uid, mail, partner=None, context=None):
154 """ Return a specific ir_email body. The main purpose of this method
155 is to be inherited by Portal, to add a link for signing in, in
156 each notification email a partner receives.
158 :param browse_record mail: mail.mail browse_record
159 :param browse_record partner: specific recipient partner
161 return mail.body_html
163 def send_get_mail_reply_to(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
173 if not mail.model or not mail.res_id:
175 if not hasattr(self.pool.get(mail.model), 'message_get_reply_to'):
177 return self.pool.get(mail.model).message_get_reply_to(cr, uid, [mail.res_id], context=context)[0]
179 def send_get_email_dict(self, cr, uid, mail, partner=None, context=None):
180 """ Return a dictionary for specific email values, depending on a
181 partner, or generic to the whole recipients given by mail.email_to.
183 :param browse_record mail: mail.mail browse_record
184 :param browse_record partner: specific recipient partner
186 body = self.send_get_mail_body(cr, uid, mail, partner=partner, context=context)
187 subject = self.send_get_mail_subject(cr, uid, mail, partner=partner, context=context)
188 reply_to = self.send_get_mail_reply_to(cr, uid, mail, partner=partner, context=context)
189 body_alternative = tools.html2plaintext(body)
190 email_to = [partner.email] if partner else tools.email_split(mail.email_to)
193 'body_alternative': body_alternative,
195 'email_to': email_to,
196 'reply_to': reply_to,
199 def send(self, cr, uid, ids, auto_commit=False, recipient_ids=None, context=None):
200 """ Sends the selected emails immediately, ignoring their current
201 state (mails that have already been sent should not be passed
202 unless they should actually be re-sent).
203 Emails successfully delivered are marked as 'sent', and those
204 that fail to be deliver are marked as 'exception', and the
205 corresponding error mail is output in the server logs.
207 :param bool auto_commit: whether to force a commit of the mail status
208 after sending each mail (meant only for scheduler processing);
209 should never be True during normal transactions (default: False)
210 :param list recipient_ids: specific list of res.partner recipients.
211 If set, one email is sent to each partner. Its is possible to
212 tune the sent email through ``send_get_mail_body`` and ``send_get_mail_subject``.
213 If not specified, one email is sent to mail_mail.email_to.
216 ir_mail_server = self.pool.get('ir.mail_server')
217 for mail in self.browse(cr, uid, ids, context=context):
221 for attach in mail.attachment_ids:
222 attachments.append((attach.datas_fname, base64.b64decode(attach.datas)))
223 # specific behavior to customize the send email for notified partners
226 for partner in self.pool.get('res.partner').browse(cr, SUPERUSER_ID, recipient_ids, context=context):
227 email_list.append(self.send_get_email_dict(cr, uid, mail, partner=partner, context=context))
229 email_list.append(self.send_get_email_dict(cr, uid, mail, context=context))
231 # build an RFC2822 email.message.Message object and send it without queuing
232 for email in email_list:
233 msg = ir_mail_server.build_email(
234 email_from = mail.email_from,
235 email_to = email.get('email_to'),
236 subject = email.get('subject'),
237 body = email.get('body'),
238 body_alternative = email.get('body_alternative'),
239 email_cc = tools.email_split(mail.email_cc),
240 reply_to = email.get('reply_to'),
241 attachments = attachments,
242 message_id = mail.message_id,
243 references = mail.references,
244 object_id = mail.res_id and ('%s-%s' % (mail.res_id, mail.model)),
246 subtype_alternative = 'plain')
247 res = ir_mail_server.send_email(cr, uid, msg,
248 mail_server_id=mail.mail_server_id.id, context=context)
250 mail.write({'state': 'sent', 'message_id': res})
253 mail.write({'state': 'exception'})
256 # /!\ can't use mail.state here, as mail.refresh() will cause an error
257 # see revid:odo@openerp.com-20120622152536-42b2s28lvdv3odyr in 6.1
259 self._postprocess_sent_message(cr, uid, mail, context=context)
261 _logger.exception('failed sending mail.mail %s', mail.id)
262 mail.write({'state': 'exception'})
264 if auto_commit == True: