1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2004-2010 Tiny SPRL (<http://tiny.be>).
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 imaplib import IMAP4
25 from imaplib import IMAP4_SSL
26 from poplib import POP3
27 from poplib import POP3_SSL
29 import cStringIO as StringIO
35 from openerp import addons
37 from openerp.osv import fields, osv
38 from openerp import tools
39 from openerp.tools.translate import _
41 _logger = logging.getLogger(__name__)
43 class fetchmail_server(osv.osv):
44 """Incoming POP/IMAP mail server account"""
45 _name = 'fetchmail.server'
46 _description = "POP/IMAP Server"
50 'name':fields.char('Name', size=256, required=True, readonly=False),
51 'active':fields.boolean('Active', required=False),
52 'state':fields.selection([
53 ('draft', 'Not Confirmed'),
54 ('done', 'Confirmed'),
55 ], 'Status', select=True, readonly=True),
56 'server' : fields.char('Server Name', size=256, readonly=True, help="Hostname or IP of the mail server", states={'draft':[('readonly', False)]}),
57 'port' : fields.integer('Port', readonly=True, states={'draft':[('readonly', False)]}),
58 'type':fields.selection([
59 ('pop', 'POP Server'),
60 ('imap', 'IMAP Server'),
61 ('local', 'Local Server'),
62 ], 'Server Type', select=True, required=True, readonly=False),
63 'is_ssl':fields.boolean('SSL/TLS', help="Connections are encrypted with SSL/TLS through a dedicated port (default: IMAPS=993, POP3S=995)"),
64 'attach':fields.boolean('Keep Attachments', help="Whether attachments should be downloaded. "
65 "If not enabled, incoming emails will be stripped of any attachments before being processed"),
66 'original':fields.boolean('Keep Original', help="Whether a full original copy of each email should be kept for reference"
67 "and attached to each processed message. This will usually double the size of your message database."),
68 'date': fields.datetime('Last Fetch Date', readonly=True),
69 'user' : fields.char('Username', size=256, readonly=True, states={'draft':[('readonly', False)]}),
70 'password' : fields.char('Password', size=1024, readonly=True, states={'draft':[('readonly', False)]}),
71 'action_id':fields.many2one('ir.actions.server', 'Server Action', help="Optional custom server action to trigger for each incoming mail, "
72 "on the record that was created or updated by this mail"),
73 'object_id': fields.many2one('ir.model', "Create a New Record", help="Process each incoming mail as part of a conversation "
74 "corresponding to this document type. This will create "
75 "new documents for new conversations, or attach follow-up "
76 "emails to the existing conversations (documents)."),
77 'priority': fields.integer('Server Priority', readonly=True, states={'draft':[('readonly', False)]}, help="Defines the order of processing, "
78 "lower values mean higher priority"),
79 'message_ids': fields.one2many('mail.mail', 'fetchmail_server_id', 'Messages', readonly=True),
80 'configuration' : fields.text('Configuration', readonly=True),
81 'script' : fields.char('Script', readonly=True, size=64),
89 'script': '/mail/static/scripts/openerp_mailgate.py',
92 def onchange_server_type(self, cr, uid, ids, server_type=False, ssl=False, object_id=False):
95 if server_type == 'pop':
96 port = ssl and 995 or 110
97 elif server_type == 'imap':
98 port = ssl and 993 or 143
100 values['server'] = ''
101 values['port'] = port
104 'dbname' : cr.dbname,
106 'model' : 'MODELNAME',
109 m = self.pool.get('ir.model')
110 r = m.read(cr,uid,[object_id],['model'])
111 conf['model']=r[0]['model']
112 values['configuration'] = """Use the below script with the following command line options with your Mail Transport Agent (MTA)
114 openerp_mailgate.py --host=HOSTNAME --port=PORT -u %(uid)d -p PASSWORD -d %(dbname)s
116 Example configuration for the postfix mta running locally:
118 /etc/postfix/virtual_aliases:
119 @youdomain openerp_mailgate@localhost
122 openerp_mailgate: "|/path/to/openerp-mailgate.py --host=localhost -u %(uid)d -p PASSWORD -d %(dbname)s"
126 return {'value':values}
128 def set_draft(self, cr, uid, ids, context=None):
129 self.write(cr, uid, ids , {'state':'draft'})
132 def connect(self, cr, uid, server_id, context=None):
133 if isinstance(server_id, (list,tuple)):
134 server_id = server_id[0]
135 server = self.browse(cr, uid, server_id, context)
136 if server.type == 'imap':
138 connection = IMAP4_SSL(server.server, int(server.port))
140 connection = IMAP4(server.server, int(server.port))
141 connection.login(server.user, server.password)
142 elif server.type == 'pop':
144 connection = POP3_SSL(server.server, int(server.port))
146 connection = POP3(server.server, int(server.port))
147 #TODO: use this to remove only unread messages
148 #connection.user("recent:"+server.user)
149 connection.user(server.user)
150 connection.pass_(server.password)
153 def button_confirm_login(self, cr, uid, ids, context=None):
156 for server in self.browse(cr, uid, ids, context=context):
158 connection = server.connect()
159 server.write({'state':'done'})
161 _logger.exception("Failed to connect to %s server %s.", server.type, server.name)
162 raise osv.except_osv(_("Connection test failed!"), _("Here is what we got instead:\n %s.") % tools.ustr(e))
166 if server.type == 'imap':
168 elif server.type == 'pop':
171 # ignored, just a consequence of the previous exception
175 def _fetch_mails(self, cr, uid, ids=False, context=None):
177 ids = self.search(cr, uid, [('state','=','done'),('type','in',['pop','imap'])])
178 return self.fetch_mail(cr, uid, ids, context=context)
180 def fetch_mail(self, cr, uid, ids, context=None):
181 """WARNING: meant for cron usage only - will commit() after each email!"""
184 context['fetchmail_cron_running'] = True
185 mail_thread = self.pool.get('mail.thread')
186 action_pool = self.pool.get('ir.actions.server')
187 for server in self.browse(cr, uid, ids, context=context):
188 _logger.info('start checking for new emails on %s server %s', server.type, server.name)
189 context.update({'fetchmail_server_id': server.id, 'server_type': server.type})
193 if server.type == 'imap':
195 imap_server = server.connect()
197 result, data = imap_server.search(None, '(UNSEEN)')
198 for num in data[0].split():
199 result, data = imap_server.fetch(num, '(RFC822)')
200 res_id = mail_thread.message_process(cr, uid, server.object_id.model,
202 save_original=server.original,
203 strip_attachments=(not server.attach),
205 if res_id and server.action_id:
206 action_pool.run(cr, uid, [server.action_id.id], {'active_id': res_id, 'active_ids':[res_id], 'active_model': context.get("thread_model", server.object_id.model)})
207 imap_server.store(num, '+FLAGS', '\\Seen')
210 _logger.info("fetched/processed %s email(s) on %s server %s", count, server.type, server.name)
212 _logger.exception("Failed to fetch mail from %s server %s.", server.type, server.name)
217 elif server.type == 'pop':
219 pop_server = server.connect()
220 (numMsgs, totalSize) = pop_server.stat()
222 for num in range(1, numMsgs + 1):
223 (header, msges, octets) = pop_server.retr(num)
224 msg = '\n'.join(msges)
225 res_id = mail_thread.message_process(cr, uid, server.object_id.model,
227 save_original=server.original,
228 strip_attachments=(not server.attach),
230 if res_id and server.action_id:
231 action_pool.run(cr, uid, [server.action_id.id], {'active_id': res_id, 'active_ids':[res_id], 'active_model': context.get("thread_model", server.object_id.model)})
234 _logger.info("fetched/processed %s email(s) on %s server %s", numMsgs, server.type, server.name)
236 _logger.exception("Failed to fetch mail from %s server %s.", server.type, server.name)
240 server.write({'date': time.strftime(tools.DEFAULT_SERVER_DATETIME_FORMAT)})
243 def cron_update(self, cr, uid, context=None):
246 if not context.get('fetchmail_cron_running'):
247 # Enabled/Disable cron based on the number of 'done' server of type pop or imap
248 ids = self.search(cr, uid, [('state','=','done'),('type','in',['pop','imap'])])
250 cron_id = self.pool.get('ir.model.data').get_object_reference(cr, uid, 'fetchmail', 'ir_cron_mail_gateway_action')[1]
251 self.pool.get('ir.cron').write(cr, 1, [cron_id], {'active': bool(ids)})
253 # Nevermind if default cron cannot be found
256 def create(self, cr, uid, values, context=None):
257 res = super(fetchmail_server, self).create(cr, uid, values, context=context)
258 self.cron_update(cr, uid, context=context)
261 def write(self, cr, uid, ids, values, context=None):
262 res = super(fetchmail_server, self).write(cr, uid, ids, values, context=context)
263 self.cron_update(cr, uid, context=context)
266 class mail_mail(osv.osv):
267 _inherit = "mail.mail"
269 'fetchmail_server_id': fields.many2one('fetchmail.server', "Inbound Mail Server",
272 oldname='server_id'),
275 def create(self, cr, uid, values, context=None):
278 fetchmail_server_id = context.get('fetchmail_server_id')
279 if fetchmail_server_id:
280 values['fetchmail_server_id'] = fetchmail_server_id
281 res = super(mail_mail, self).create(cr, uid, values, context=context)
284 def write(self, cr, uid, ids, values, context=None):
287 fetchmail_server_id = context.get('fetchmail_server_id')
288 if fetchmail_server_id:
289 values['fetchmail_server_id'] = fetchmail_server_id
290 res = super(mail_mail, self).write(cr, uid, ids, values, context=context)
294 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: