1. zikzakmedia
  2. trytond-electronic_mail_template


trytond-electronic_mail_template / template.py

# -*- coding: UTF-8 -*-
#This file is part electronic_mail_template module for Tryton.
#The COPYRIGHT file at the top level of this repository contains 
#the full copyright notices and license terms.
"Email Template"
from __future__ import with_statement

    from cStringIO import StringIO
except ImportError:
    from StringIO import StringIO
import mimetypes
import base64
from email.mime.multipart import MIMEMultipart
from email.mime.text import MIMEText
from email.mime.base import MIMEBase
from email.utils import formatdate

from genshi.template import TextTemplate
from trytond.model import ModelView, ModelSQL, fields
from trytond.tools import safe_eval, get_smtp_server
from trytond.transaction import Transaction
from trytond.pyson import Eval
from trytond.pool import Pool

def split_emails(emails):
    """Email IDs could be separated by ';' or ','

    >>> email_list = '1@x.com;2@y.com , 3@z.com '
    >>> emails = split_emails(email_list)
    >>> emails
    ['1@x.com', '2@y.com', '3@z.com']

    :param email_ids: email id
    :type email_ids: str or unicode
    if not emails:
        return []
    emails = emails.replace(' ', '').replace(',', ';')
    return emails.split(';')

def recepients_from_fields(email_record):
    Returns a list of email addresses who are the recipients of this email

    :param email_record: Browse record of the email
    recepients = [ ]
    for field in ('to', 'cc', 'bcc'):
        recepients.extend(split_emails(getattr(email_record, field)))
    return recepients

__all__ = ['Template', 'TemplateReport']

class Template(ModelSQL, ModelView):
    'Email Template'
    __name__ = 'electronic.mail.template'
    _inherits = {
        'electronic.mail': 'electronic_mail',

    #: The design inherits from elecronic mail because a template
    #: is infact the source record to generate an electronic mail
    electronic_mail = fields.Many2One(
        'electronic.mail', 'Email', required=True, ondelete='CASCADE')
    smtp_server = fields.Many2One('smtp.server', 'SMTP Server', 
        domain=[('state', '=', 'done')], required=True)
    name = fields.Char('Name', required=True)
    model = fields.Many2One(
        'ir.model', 'Model', required=True, select="1")
    draft_mailbox = fields.Many2One(
        'electronic.mail.mailbox', 'Draft Mailbox', required=True)

    # All the following fields are expression fields which are evaluated
    # safely, the other fields are directly used from electronic_mail itself
    language = fields.Char(
        'Language', help='Expression to find the ISO langauge code', select="2")
    plain = fields.Text('Plain Text Body', translate=True)
    html = fields.Text('HTML Body', translate=True)
    reports = fields.Many2Many(
        'template', 'report', 'Reports')
    engine = fields.Selection(
        'get_engines', 'Engine', required=True, select="2")
    triggers = fields.One2Many(
        'ir.trigger', 'email_template', 'Triggers',
            'model': Eval('model'),
            'email_template': True,
    signature =  fields.Boolean('Use Signature',
        help='The signature from the User details will be appened to the mail.')

    def __setup__(cls):
        super(Template, cls).__setup__()
            'smtp_error': 'Wrong connection to SMTP server. Email have not sent',
            'recipients_error': 'Not valid recipients emails. Check emails in TO, CC or BBC',
            'smtp_server_default': 'There are not default SMTP server',

    def default_template():
        return True

    def default_engine():
        '''Default Engine'''
        return 'genshi'

    def get_engines(cls):
        '''Returns the engines as list of tuple

        :return: List of tuples
        engines = [ 
            ('python', 'Python'),
            ('genshi', 'Genshi'),
        return engines

    def check_xml_record(cls, records, values):
        '''It should be possible to overwrite templates'''
        return True

    def eval(self, template, expression, record):
        '''Evaluates the given :attr:expression

        :param template: Browse record of the template
        :param expression: Expression to evaluate
        :param record: The browse record of the record
        engine_method = getattr(self, '_engine_' + template.engine)
        return engine_method(expression, record)

    def template_context(record):
        """Generate the tempalte context

        This is mainly to assist in the inheritance pattern
        return {'record': record}

    def _engine_python(self, expression, record):
        '''Evaluate the pythonic expression and return its value
        if expression is None:
            return u''

        assert record is not None, 'Record is undefined'
        template_context = self.template_context(record)
        return safe_eval(expression, template_context)

    def _engine_genshi(self, expression, record):
        :param expression: Expression to evaluate
        :param record: Browse record
        if not expression:
            return u''

        template = TextTemplate(expression)
        template_context = self.template_context(record)
        return template.generate(**template_context).render(encoding='UTF-8')

    def render(self, template, record):
        '''Renders the template and returns as email object
        :param template: Browse Record of the template
        :param record: Browse Record of the record on which the template
            is to generate the data on
        :return: 'email.message.Message' instance

        message = MIMEMultipart('alternative')
        message['date'] = formatdate(localtime=1)

        language = Transaction().context.get('language', 'en_US')
        if template.language:
            language = self.eval(template, template.language, record)

        with Transaction().set_context(language = language):
            template = self(template.id)

            # Simple rendering fields
            simple_fields = {
                'from_': 'from',
                'sender': 'sender',
                'to': 'to',
                'cc': 'cc',
                'bcc': 'bcc',
                'subject': 'subject',
                'message_id': 'message-id',
                'in_reply_to': 'in-reply-to',
            for field_name in simple_fields.keys():
                field_expression = getattr(template, field_name)
                eval_result = self.eval(template, field_expression, record)
                if eval_result:
                    message[simple_fields[field_name]] = eval_result

            # Attach reports
            if template.reports:
                reports = self.render_reports(
                    template, record
                for report in reports:
                    ext, data, filename, file_name = report[0:5]
                    if file_name:
                        filename = self.eval(template, file_name, record)
                    filename = ext and '%s.%s' % (filename, ext) or filename
                    content_type, _ = mimetypes.guess_type(filename)
                    maintype, subtype = (
                        content_type or 'application/octet-stream'
                        ).split('/', 1)

                    attachment = MIMEBase(maintype, subtype)

                        'Content-Disposition', 'attachment', filename=filename)
                        'Content-Transfer-Encoding', 'base64')

            # HTML & Text Alternate parts
            plain = self.eval(template, template.plain, record)
            html = self.eval(template, template.html, record)
            if template.signature:
                User = Pool().get('res.user')
                user = User(Transaction().user)
                if user.signature:
                    signature = user.signature.encode("ASCII", 'ignore')
                    plain = '%s\n--\n%s' % (plain, signature)
                    html = '%s<br>--<br>%s' % (plain, signature.replace('\n', '<br>'))
            message.attach(MIMEText(plain, 'plain'))
            message.attach(MIMEText(html, 'html'))

            # Add headers
            for header in template.headers:
                    unicode(self.eval(template, header.value, record))

        return message

    def render_reports(self, template, record):
        '''Renders the reports and returns as a list of tuple

        :param template: Browse Record of the template
        :param record: Browse Record of the record on which the template
            is to generate the data on
        :return: List of tuples with:
            the report name
            the report file name (optional)
        reports = [ ]
        for report_action in template.reports:
            report = Pool().get(report_action.report_name, type='report')
            reports.append([report.execute([record.id], {'id': record.id}), report_action.file_name])

        # The boolean for direct print in the tuple is useless for emails
        return [(r[0][0], r[0][1], r[0][3], r[1]) for r in reports]

    def render_and_send(self, template_id, records):
        Render the template and send
        :param template_id: ID template
        :param records: List Object of the records
        template = self(template_id)
        Record = Pool().get(template.model.model)
        ElectronicMail = Pool().get('electronic.mail')
        for record in records:
            email_message = self.render(template, record)
            email = ElectronicMail.create_from_email(
                email_message, template.mailbox.id)
            self.send_email(email, template)
            self.add_event(template, record, email, email_message) #add event
        return True

    def mail_from_trigger(self, records, trigger_id):
        To be used with ir.trigger to send mails automatically

        The process involves identifying the tempalte which needs
        to be pulled when the trigger is.

        :param records: Object of the records
        :param trigger_id: ID of the trigger
        Trigger = Pool().get('ir.trigger')
        trigger = Trigger(trigger_id)
        return self.render_and_send(trigger.email_template.id, records)

    def send_email(self, email_id, template=False):
        Send out the given email using the SMTP_CLIENT if configured in the
        Tryton Server configuration

        :param email_id: ID of the email to be sent
        :param template: Browse Record of the template
        ElectronicMail = Pool().get('electronic.mail')
        SMTP = Pool().get('smtp.server')

        email = ElectronicMail(email_id)
        recepients = recepients_from_fields(email)

        """SMTP Server from template or default"""
        if not template:
            servers = SMTP.search([('state','=','done'),('default','=',True)])
            if not len(servers)>0:
        server = template and template.smtp_server or servers[0]

        """Validate recipients to send or move email to draft mailbox"""
        emails = ",".join(recepients)
        if not ElectronicMail.get_email_valid(emails) and template:
            """Draft Mailbox. Not send email"""
            ElectronicMail.write([email], {
                'mailbox': template.draft_mailbox,
            return False

            server = SMTP.get_smtp_server(server)
            server.sendmail(email.from_, recepients,
            ElectronicMail.write([email], {
                'flag_send': True,
        return True

    def add_event(self, template, record, email, email_message):
        Add event if party_event is installed
        :param template: Browse Record of the template
        :param record: Browse record of the record
        :param email: Browse record email to send
        :param email_message: Data email to extract values
        cursor = Transaction().cursor
        cursor.execute("SELECT state from ir_module_module where state='installed' and name = 'party_event'")
        party_event = cursor.fetchall()
        if template.party and party_event:
            party = self.eval(template, template.party, record)
            resource = 'electronic.mail,%s' % email.id
            values = {
                'description':self.eval(template, template.plain, record),
            Pool().get('party.event').create_event(party, resource, values)
        return True

class TemplateReport(ModelSQL):
    'Template - Report Action'
    __name__ = 'electronic.mail.template.ir.action.report'

    template = fields.Many2One('electronic.mail.template', 'Template')
    report = fields.Many2One('ir.action.report', 'Report')