2 fix_imap_internaldate.py - Fix the INTERNALDATE field on IMAP servers
4 Copyright (c) 2012 Intra2net AG
5 Author: Plamen Dimitrov
7 This program is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (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 General Public License for more details.
21 # python version handling
25 print("This module needs python version 3 or later.")
28 from mail_date_parser import MailDateParser
29 from mail_iterator import MailIterator
30 from caching_data import CachingData
33 """Interprets command arguments and initializes configuration and logger.
34 Then begins mail synchronization."""
37 parser = argparse.ArgumentParser(description="Fix the INTERNALDATE field on IMAP servers. "
38 "Small tool to fix the IMAP internaldate "
39 "in case it's too much off compared to the last date "
40 "stored in the received lines.")
41 parser.add_argument('-u', '--update', dest='test_mode', action='store_false',
42 default=True, help='update all e-mails and exit test mode')
44 # config and logging setup
45 config = load_configuration()
46 prepare_logger(config)
47 args = parser.parse_args()
49 logging.info("Testing mode initiated. No message will be modified on the server.")
51 logging.info("Update mode initiated. Messages will be modified.")
53 # proceed to main functionality
55 synchronize_csv(config, args.test_mode)
56 except KeyboardInterrupt:
57 logging.info("Script was interrupted by the user.")
61 def load_configuration():
62 """Loads the script configuration from a file or creates such."""
63 config = configparser.RawConfigParser()
64 success = config.read('confscript.cfg')
66 config.add_section('basic_settings')
67 config.set('basic_settings', 'file_log_level', logging.INFO)
68 config.set('basic_settings', 'console_log_level', logging.INFO)
69 config.set('basic_settings', 'imap_server', 'imap.company.com')
70 config.set('basic_settings', 'tolerance', 30)
71 with open('confscript.cfg', 'w') as configfile:
72 config.write(configfile)
75 def prepare_logger(config):
76 """Sets up the logging functionality"""
79 with open('fix_imap_internaldate.log', 'w'):
82 # add basic configuration
83 logging.basicConfig(filename='fix_imap_internaldate.log',
84 format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
85 level=config.getint('basic_settings', 'file_log_level'))
87 # add a handler for a console output
88 console = logging.StreamHandler()
89 console.setLevel(config.getint('basic_settings', 'console_log_level'))
90 formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
91 console.setFormatter(formatter)
92 logging.getLogger('').addHandler(console)
95 def synchronize_csv(config, test_mode):
96 """Iterates through csv list of users and synchronizes their messages."""
98 # initialize loop permanent data
99 caching_data = CachingData()
100 date_parser = MailDateParser()
101 server = config.get('basic_settings', 'imap_server')
102 tolerance = config.getint('basic_settings', 'tolerance') * 60
104 # iterate through the users in the csv data
105 user_reader = csv.DictReader(open("userdata.csv", "r"), delimiter=',')
106 for user in user_reader:
108 session = MailIterator(server, user['username'], user['password'])
109 except UserWarning as ex:
112 for mailbox in session:
114 box = caching_data.retrieve_cached_mailbox(mailbox[0], mailbox[1], user['username'])
115 mail_ids = session.fetch_messages()
116 new_ids = box.synchronize(mail_ids, tolerance)
117 logging.info("%s new messages out of %s found in %s.", len(new_ids), len(mail_ids), box.name)
118 except UserWarning as ex:
123 fetched_internal_date = session.fetch_internal_date(mid)
124 internal_date = date_parser.extract_internal_date(fetched_internal_date)
125 fetched_received_date = session.fetch_received_date(mid)
126 received_date = date_parser.extract_received_date(fetched_received_date)
127 if(received_date==""):
128 logging.debug("No received date could be found in message uid: %s - mailbox: %s - user: %s.",
129 mid.decode('iso-8859-1'), box.name, box.owner)
130 box.no_received_field += 1
132 except UserWarning as ex:
135 if(date_parser.compare_dates(received_date, internal_date, tolerance)):
136 logging.warning("Date conflict found in message uid: %s - mailbox: %s - user: %s.\nInternal date %s is different from received date %s from RECEIVED header:\n%s.",
137 mid.decode('iso-8859-1'), box.name, box.owner,
138 internal_date.strftime("%d %b %Y %H:%M:%S"),
139 received_date.strftime("%d %b %Y %H:%M:%S"),
140 fetched_received_date.split("Received:")[1])
143 session.update_message(mid, box.name, received_date)
144 except UserWarning as ex:
148 # count total emails for every user and mailbox
149 box.date_conflicts += 1
151 # if all messages were successfully fixed confirm caching
155 # final report on date conflicts
156 caching_data.report_conflicts()
159 if(__name__ == "__main__"):