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
38 from osv import osv, fields
40 from tools.translate import _
42 _logger = logging.getLogger(__name__)
44 class fetchmail_server(osv.osv):
45 """Incoming POP/IMAP mail server account"""
46 _name = 'fetchmail.server'
47 _description = "POP/IMAP Server"
51 'name':fields.char('Name', size=256, required=True, readonly=False),
52 'active':fields.boolean('Active', required=False),
53 'state':fields.selection([
54 ('draft', 'Not Confirmed'),
55 ('done', 'Confirmed'),
56 ], 'Status', select=True, readonly=True),
57 'server' : fields.char('Server Name', size=256, readonly=True, help="Hostname or IP of the mail server", states={'draft':[('readonly', False)]}),
58 'port' : fields.integer('Port', readonly=True, states={'draft':[('readonly', False)]}),
59 'type':fields.selection([
60 ('pop', 'POP Server'),
61 ('imap', 'IMAP Server'),
62 ('local', 'Local Server'),
63 ], 'Server Type', select=True, required=True, readonly=False),
64 'is_ssl':fields.boolean('SSL/TLS', help="Connections are encrypted with SSL/TLS through a dedicated port (default: IMAPS=993, POP3S=995)"),
65 'attach':fields.boolean('Keep Attachments', help="Whether attachments should be downloaded. "
66 "If not enabled, incoming emails will be stripped of any attachments before being processed"),
67 'original':fields.boolean('Keep Original', help="Whether a full original copy of each email should be kept for reference"
68 "and attached to each processed message. This will usually double the size of your message database."),
69 'date': fields.datetime('Last Fetch Date', readonly=True),
70 'user' : fields.char('Username', size=256, readonly=True, states={'draft':[('readonly', False)]}),
71 'password' : fields.char('Password', size=1024, readonly=True, states={'draft':[('readonly', False)]}),
72 'action_id':fields.many2one('ir.actions.server', 'Server Action', help="Optional custom server action to trigger for each incoming mail, "
73 "on the record that was created or updated by this mail"),
74 'object_id': fields.many2one('ir.model', "Create a New Record", required=True, help="Process each incoming mail as part of a conversation "
75 "corresponding to this document type. This will create "
76 "new documents for new conversations, or attach follow-up "
77 "emails to the existing conversations (documents)."),
78 'priority': fields.integer('Server Priority', readonly=True, states={'draft':[('readonly', False)]}, help="Defines the order of processing, "
79 "lower values mean higher priority"),
80 'message_ids': fields.one2many('mail.message', 'fetchmail_server_id', 'Messages', readonly=True),
81 'configuration' : fields.text('Configuration'),
82 'script' : fields.char('Script', readonly=True, size=64),
90 'script': '/mail/static/scripts/openerp_mailgate.py',
94 def onchange_server_type(self, cr, uid, ids, server_type=False, ssl=False, object_id=False):
97 if server_type == 'pop':
98 port = ssl and 995 or 110
99 elif server_type == 'imap':
100 port = ssl and 993 or 143
102 values['server'] = ''
103 values['port'] = port
106 'dbname' : cr.dbname,
108 'model' : 'MODELNAME',
111 m = self.pool.get('ir.model')
112 r = m.read(cr,uid,[object_id],['model'])
113 conf['model']=r[0]['model']
114 values['configuration'] = """Use the below script with the following command line options with your Mail Transport Agent (MTA)
116 openerp_mailgate.py -u %(uid)d -p PASSWORD -o %(model)s -d %(dbname)s --host=HOSTNAME --port=PORT
119 return {'value':values}
121 def set_draft(self, cr, uid, ids, context=None):
122 self.write(cr, uid, ids , {'state':'draft'})
125 def connect(self, cr, uid, server_id, context=None):
126 if isinstance(server_id, (list,tuple)):
127 server_id = server_id[0]
128 server = self.browse(cr, uid, server_id, context)
129 if server.type == 'imap':
131 connection = IMAP4_SSL(server.server, int(server.port))
133 connection = IMAP4(server.server, int(server.port))
134 connection.login(server.user, server.password)
135 elif server.type == 'pop':
137 connection = POP3_SSL(server.server, int(server.port))
139 connection = POP3(server.server, int(server.port))
140 #TODO: use this to remove only unread messages
141 #connection.user("recent:"+server.user)
142 connection.user(server.user)
143 connection.pass_(server.password)
146 def button_confirm_login(self, cr, uid, ids, context=None):
149 for server in self.browse(cr, uid, ids, context=context):
151 connection = server.connect()
152 server.write({'state':'done'})
154 _logger.exception("Failed to connect to %s server %s", server.type, server.name)
155 raise osv.except_osv(_("Connection test failed!"), _("Here is what we got instead:\n %s") % tools.ustr(e))
159 if server.type == 'imap':
161 elif server.type == 'pop':
164 # ignored, just a consequence of the previous exception
168 def _fetch_mails(self, cr, uid, ids=False, context=None):
170 ids = self.search(cr, uid, [('state','=','done')])
171 return self.fetch_mail(cr, uid, ids, context=context)
173 def fetch_mail(self, cr, uid, ids, context=None):
174 """WARNING: meant for cron usage only - will commit() after each email!"""
177 mail_thread = self.pool.get('mail.thread')
178 action_pool = self.pool.get('ir.actions.server')
179 for server in self.browse(cr, uid, ids, context=context):
180 _logger.info('start checking for new emails on %s server %s', server.type, server.name)
181 context.update({'fetchmail_server_id': server.id, 'server_type': server.type})
185 if server.type == 'imap':
187 imap_server = server.connect()
189 result, data = imap_server.search(None, '(UNSEEN)')
190 for num in data[0].split():
191 result, data = imap_server.fetch(num, '(RFC822)')
192 res_id = mail_thread.message_process(cr, uid, server.object_id.model, data[0][1],
193 save_original=server.original,
194 strip_attachments=(not server.attach),
196 if res_id and server.action_id:
197 action_pool.run(cr, uid, [server.action_id.id], {'active_id': res_id, 'active_ids':[res_id]})
198 imap_server.store(num, '+FLAGS', '\\Seen')
201 _logger.info("fetched/processed %s email(s) on %s server %s", count, server.type, server.name)
203 _logger.exception("Failed to fetch mail from %s server %s", server.type, server.name)
208 elif server.type == 'pop':
210 pop_server = server.connect()
211 (numMsgs, totalSize) = pop_server.stat()
213 for num in range(1, numMsgs + 1):
214 (header, msges, octets) = pop_server.retr(num)
215 msg = '\n'.join(msges)
216 res_id = mail_thread.message_process(cr, uid, server.object_id.model,
218 save_original=server.original,
219 strip_attachments=(not server.attach),
221 if res_id and server.action_id:
222 action_pool.run(cr, uid, [server.action_id.id], {'active_id': res_id, 'active_ids':[res_id]})
225 _logger.info("fetched/processed %s email(s) on %s server %s", numMsgs, server.type, server.name)
227 _logger.exception("Failed to fetch mail from %s server %s", server.type, server.name)
231 server.write({'date': time.strftime(tools.DEFAULT_SERVER_DATETIME_FORMAT)})
234 class mail_message(osv.osv):
235 _inherit = "mail.message"
237 'fetchmail_server_id': fields.many2one('fetchmail.server', "Inbound Mail Server",
240 oldname='server_id'),
243 def create(self, cr, uid, values, context=None):
246 fetchmail_server_id = context.get('fetchmail_server_id')
247 if fetchmail_server_id:
248 values['fetchmail_server_id'] = fetchmail_server_id
249 res = super(mail_message,self).create(cr, uid, values, context=context)
252 def write(self, cr, uid, ids, values, context=None):
255 fetchmail_server_id = context.get('fetchmail_server_id')
256 if fetchmail_server_id:
257 values['fetchmail_server_id'] = server_id
258 res = super(mail_message,self).write(cr, uid, ids, values, context=context)
262 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: