diff options
Diffstat (limited to 'addons/fetchmail/fetchmail.py')
| -rw-r--r-- | addons/fetchmail/fetchmail.py | 299 |
1 files changed, 0 insertions, 299 deletions
diff --git a/addons/fetchmail/fetchmail.py b/addons/fetchmail/fetchmail.py deleted file mode 100644 index 203c3ee1fbc..00000000000 --- a/addons/fetchmail/fetchmail.py +++ /dev/null @@ -1,299 +0,0 @@ -# -*- coding: utf-8 -*- -# Part of Odoo. See LICENSE file for full copyright and licensing details. - -import logging -import poplib -import time -from imaplib import IMAP4 -from imaplib import IMAP4_SSL -from poplib import POP3 -from poplib import POP3_SSL -try: - import cStringIO as StringIO -except ImportError: - import StringIO - -from openerp.osv import fields, osv -from openerp import tools, api, SUPERUSER_ID -from openerp.tools.translate import _ -from openerp.exceptions import UserError - -_logger = logging.getLogger(__name__) -MAX_POP_MESSAGES = 50 -MAIL_TIMEOUT = 60 - -# Workaround for Python 2.7.8 bug https://bugs.python.org/issue23906 -poplib._MAXLINE = 65536 - -class fetchmail_server(osv.osv): - """Incoming POP/IMAP mail server account""" - _name = 'fetchmail.server' - _description = "POP/IMAP Server" - _order = 'priority' - - _columns = { - 'name':fields.char('Name', required=True, readonly=False), - 'active':fields.boolean('Active', required=False), - 'state':fields.selection([ - ('draft', 'Not Confirmed'), - ('done', 'Confirmed'), - ], 'Status', select=True, readonly=True, copy=False), - 'server' : fields.char('Server Name', readonly=True, help="Hostname or IP of the mail server", states={'draft':[('readonly', False)]}), - 'port' : fields.integer('Port', readonly=True, states={'draft':[('readonly', False)]}), - 'type':fields.selection([ - ('pop', 'POP Server'), - ('imap', 'IMAP Server'), - ('local', 'Local Server'), - ], 'Server Type', select=True, required=True, readonly=False), - 'is_ssl':fields.boolean('SSL/TLS', help="Connections are encrypted with SSL/TLS through a dedicated port (default: IMAPS=993, POP3S=995)"), - 'attach':fields.boolean('Keep Attachments', help="Whether attachments should be downloaded. " - "If not enabled, incoming emails will be stripped of any attachments before being processed"), - 'original':fields.boolean('Keep Original', help="Whether a full original copy of each email should be kept for reference " - "and attached to each processed message. This will usually double the size of your message database."), - 'date': fields.datetime('Last Fetch Date', readonly=True), - 'user' : fields.char('Username', readonly=True, states={'draft':[('readonly', False)]}), - 'password' : fields.char('Password', readonly=True, states={'draft':[('readonly', False)]}), - 'action_id':fields.many2one('ir.actions.server', 'Server Action', help="Optional custom server action to trigger for each incoming mail, " - "on the record that was created or updated by this mail"), - 'object_id': fields.many2one('ir.model', "Create a New Record", help="Process each incoming mail as part of a conversation " - "corresponding to this document type. This will create " - "new documents for new conversations, or attach follow-up " - "emails to the existing conversations (documents)."), - 'priority': fields.integer('Server Priority', readonly=True, states={'draft':[('readonly', False)]}, help="Defines the order of processing, " - "lower values mean higher priority"), - 'message_ids': fields.one2many('mail.mail', 'fetchmail_server_id', 'Messages', readonly=True), - 'configuration' : fields.text('Configuration', readonly=True), - 'script' : fields.char('Script', readonly=True), - } - _defaults = { - 'state': "draft", - 'type': "pop", - 'active': True, - 'priority': 5, - 'attach': True, - 'script': '/mail/static/scripts/openerp_mailgate.py', - } - - def onchange_server_type(self, cr, uid, ids, server_type=False, ssl=False, object_id=False): - port = 0 - values = {} - if server_type == 'pop': - port = ssl and 995 or 110 - elif server_type == 'imap': - port = ssl and 993 or 143 - else: - values['server'] = '' - values['port'] = port - - conf = { - 'dbname' : cr.dbname, - 'uid' : uid, - 'model' : 'MODELNAME', - } - if object_id: - m = self.pool.get('ir.model') - r = m.read(cr,uid,[object_id],['model']) - conf['model']=r[0]['model'] - values['configuration'] = """Use the below script with the following command line options with your Mail Transport Agent (MTA) - -openerp_mailgate.py --host=HOSTNAME --port=PORT -u %(uid)d -p PASSWORD -d %(dbname)s - -Example configuration for the postfix mta running locally: - -/etc/postfix/virtual_aliases: -@youdomain openerp_mailgate@localhost - -/etc/aliases: -openerp_mailgate: "|/path/to/openerp-mailgate.py --host=localhost -u %(uid)d -p PASSWORD -d %(dbname)s" - -""" % conf - - return {'value':values} - - def set_draft(self, cr, uid, ids, context=None): - self.write(cr, uid, ids , {'state':'draft'}) - return True - - @api.cr_uid_ids_context - def connect(self, cr, uid, server_id, context=None): - if isinstance(server_id, (list,tuple)): - server_id = server_id[0] - server = self.browse(cr, uid, server_id, context) - if server.type == 'imap': - if server.is_ssl: - connection = IMAP4_SSL(server.server, int(server.port)) - else: - connection = IMAP4(server.server, int(server.port)) - connection.login(server.user, server.password) - elif server.type == 'pop': - if server.is_ssl: - connection = POP3_SSL(server.server, int(server.port)) - else: - connection = POP3(server.server, int(server.port)) - #TODO: use this to remove only unread messages - #connection.user("recent:"+server.user) - connection.user(server.user) - connection.pass_(server.password) - # Add timeout on socket - connection.sock.settimeout(MAIL_TIMEOUT) - return connection - - def button_confirm_login(self, cr, uid, ids, context=None): - if context is None: - context = {} - for server in self.browse(cr, uid, ids, context=context): - try: - connection = server.connect() - server.write({'state':'done'}) - except Exception, e: - _logger.info("Failed to connect to %s server %s.", server.type, server.name, exc_info=True) - raise UserError(_("Connection test failed: %s") % tools.ustr(e)) - finally: - try: - if connection: - if server.type == 'imap': - connection.close() - elif server.type == 'pop': - connection.quit() - except Exception: - # ignored, just a consequence of the previous exception - pass - return True - - def _fetch_mails(self, cr, uid, ids=False, context=None): - if not ids: - ids = self.search(cr, uid, [('state','=','done'),('type','in',['pop','imap'])]) - return self.fetch_mail(cr, uid, ids, context=context) - - def fetch_mail(self, cr, uid, ids, context=None): - """WARNING: meant for cron usage only - will commit() after each email!""" - context = dict(context or {}) - context['fetchmail_cron_running'] = True - mail_thread = self.pool.get('mail.thread') - action_pool = self.pool.get('ir.actions.server') - for server in self.browse(cr, uid, ids, context=context): - _logger.info('start checking for new emails on %s server %s', server.type, server.name) - context.update({'fetchmail_server_id': server.id, 'server_type': server.type}) - count, failed = 0, 0 - imap_server = False - pop_server = False - if server.type == 'imap': - try: - imap_server = server.connect() - imap_server.select() - result, data = imap_server.search(None, '(UNSEEN)') - for num in data[0].split(): - res_id = None - result, data = imap_server.fetch(num, '(RFC822)') - imap_server.store(num, '-FLAGS', '\\Seen') - try: - res_id = mail_thread.message_process(cr, uid, server.object_id.model, - data[0][1], - save_original=server.original, - strip_attachments=(not server.attach), - context=context) - except Exception: - _logger.info('Failed to process mail from %s server %s.', server.type, server.name, exc_info=True) - failed += 1 - if res_id and server.action_id: - 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)}) - imap_server.store(num, '+FLAGS', '\\Seen') - cr.commit() - count += 1 - _logger.info("Fetched %d email(s) on %s server %s; %d succeeded, %d failed.", count, server.type, server.name, (count - failed), failed) - except Exception: - _logger.info("General failure when trying to fetch mail from %s server %s.", server.type, server.name, exc_info=True) - finally: - if imap_server: - imap_server.close() - imap_server.logout() - elif server.type == 'pop': - try: - while True: - pop_server = server.connect() - (numMsgs, totalSize) = pop_server.stat() - pop_server.list() - for num in range(1, min(MAX_POP_MESSAGES, numMsgs) + 1): - (header, msges, octets) = pop_server.retr(num) - msg = '\n'.join(msges) - res_id = None - try: - res_id = mail_thread.message_process(cr, uid, server.object_id.model, - msg, - save_original=server.original, - strip_attachments=(not server.attach), - context=context) - pop_server.dele(num) - except Exception: - _logger.info('Failed to process mail from %s server %s.', server.type, server.name, exc_info=True) - failed += 1 - if res_id and server.action_id: - 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)}) - cr.commit() - if numMsgs < MAX_POP_MESSAGES: - break - pop_server.quit() - _logger.info("Fetched %d email(s) on %s server %s; %d succeeded, %d failed.", numMsgs, server.type, server.name, (numMsgs - failed), failed) - except Exception: - _logger.info("General failure when trying to fetch mail from %s server %s.", server.type, server.name, exc_info=True) - finally: - if pop_server: - pop_server.quit() - server.write({'date': time.strftime(tools.DEFAULT_SERVER_DATETIME_FORMAT)}) - return True - - def _update_cron(self, cr, uid, context=None): - if context and context.get('fetchmail_cron_running'): - return - - try: - cron = self.pool['ir.model.data'].get_object( - cr, SUPERUSER_ID, 'fetchmail', 'ir_cron_mail_gateway_action', context=context) - except ValueError: - # Nevermind if default cron cannot be found - return - - # Enabled/Disable cron based on the number of 'done' server of type pop or imap - cron.toggle(model=self._name, domain=[('state','=','done'), ('type','in',['pop','imap'])]) - - def create(self, cr, uid, values, context=None): - res = super(fetchmail_server, self).create(cr, uid, values, context=context) - self._update_cron(cr, uid, context=context) - return res - - def write(self, cr, uid, ids, values, context=None): - res = super(fetchmail_server, self).write(cr, uid, ids, values, context=context) - self._update_cron(cr, uid, context=context) - return res - - def unlink(self, cr, uid, ids, context=None): - res = super(fetchmail_server, self).unlink(cr, uid, ids, context=context) - self._update_cron(cr, uid, context=context) - return res - -class mail_mail(osv.osv): - _inherit = "mail.mail" - _columns = { - 'fetchmail_server_id': fields.many2one('fetchmail.server', "Inbound Mail Server", - readonly=True, - select=True, - oldname='server_id'), - } - - def create(self, cr, uid, values, context=None): - if context is None: - context = {} - fetchmail_server_id = context.get('fetchmail_server_id') - if fetchmail_server_id: - values['fetchmail_server_id'] = fetchmail_server_id - res = super(mail_mail, self).create(cr, uid, values, context=context) - return res - - def write(self, cr, uid, ids, values, context=None): - if context is None: - context = {} - fetchmail_server_id = context.get('fetchmail_server_id') - if fetchmail_server_id: - values['fetchmail_server_id'] = fetchmail_server_id - res = super(mail_mail, self).write(cr, uid, ids, values, context=context) - return res |